Use prefix arg 0 to inhibit note taking for TODO change
[org-mode.git] / lisp / org.el
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.7
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
17
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 ;; GNU General Public License for more details.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text.  Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured.  Visibility cycling and structure editing
36 ;; help to work with the tree.  Tables are easily created with a built-in
37 ;; table editor.  Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling.  It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects.  For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file.  It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;;   http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file.  The
56 ;; distribution also contains a PDF version of it.  At the homepage of
57 ;; Org-mode, you can read the same text online as HTML.  There is also an
58 ;; excellent reference card made by Philip Rooke.  This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
65
66 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
67 (defvar org-table-formula-constants-local nil
68   "Local version of `org-table-formula-constants'.")
69 (make-variable-buffer-local 'org-table-formula-constants-local)
70
71 ;;;; Require other packages
72
73 (eval-when-compile
74   (require 'cl)
75   (require 'gnus-sum))
76
77 (require 'calendar)
78
79 ;; Emacs 22 calendar compatibility:  Make sure the new variables are available
80 (when (fboundp 'defvaralias)
81   (unless (boundp 'calendar-view-holidays-initially-flag)
82     (defvaralias 'calendar-view-holidays-initially-flag
83       'view-calendar-holidays-initially))
84   (unless (boundp 'calendar-view-diary-initially-flag)
85     (defvaralias 'calendar-view-diary-initially-flag
86       'view-diary-entries-initially))
87   (unless (boundp 'diary-fancy-buffer)
88     (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
89
90 (require 'outline) (require 'noutline)
91 ;; Other stuff we need.
92 (require 'time-date)
93 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
94 (require 'easymenu)
95 (require 'overlay)
96
97 (require 'org-macs)
98 (require 'org-entities)
99 (require 'org-compat)
100 (require 'org-faces)
101 (require 'org-list)
102 (require 'org-pcomplete)
103 (require 'org-src)
104 (require 'org-footnote)
105
106 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
107 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
108 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
110 (declare-function org-at-clock-log-p "org-clock" ())
111 (declare-function org-clock-timestamps-up "org-clock" ())
112 (declare-function org-clock-timestamps-down "org-clock" ())
113
114 ;; babel
115 (require 'ob)
116 (require 'ob-table)
117 (require 'ob-lob)
118 (require 'ob-ref)
119 (require 'ob-tangle)
120 (require 'ob-comint)
121 (require 'ob-keys)
122
123 ;; load languages based on value of `org-babel-load-languages'
124 (defvar org-babel-load-languages)
125 ;;;###autoload
126 (defun org-babel-do-load-languages (sym value)
127   "Load the languages defined in `org-babel-load-languages'."
128   (set-default sym value)
129   (mapc (lambda (pair)
130           (let ((active (cdr pair)) (lang (symbol-name (car pair))))
131             (if active
132                 (progn
133                   (require (intern (concat "ob-" lang))))
134               (progn
135                 (funcall 'fmakunbound
136                          (intern (concat "org-babel-execute:" lang)))
137                 (funcall 'fmakunbound
138                          (intern (concat "org-babel-expand-body:" lang)))))))
139         org-babel-load-languages))
140
141 (defcustom org-babel-load-languages '((emacs-lisp . t))
142   "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes.  When a language is
146 \"loaded\", then code blocks in that language can be evaluated
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding.  By default only Emacs Lisp (which has no
151 requirements) is loaded."
152   :group 'org-babel
153   :set 'org-babel-do-load-languages
154   :type '(alist :tag "Babel Languages"
155                 :key-type
156                 (choice
157                  (const :tag "Awk" awk)
158                  (const :tag "C" C)
159                  (const :tag "R" R)
160                  (const :tag "Asymptote" asymptote)
161                  (const :tag "Calc" calc)
162                  (const :tag "Clojure" clojure)
163                  (const :tag "CSS" css)
164                  (const :tag "Ditaa" ditaa)
165                  (const :tag "Dot" dot)
166                  (const :tag "Emacs Lisp" emacs-lisp)
167                  (const :tag "Fortran" fortran)
168                  (const :tag "Gnuplot" gnuplot)
169                  (const :tag "Haskell" haskell)
170                  (const :tag "Java" java)
171                  (const :tag "Javascript" js)
172                  (const :tag "Latex" latex)
173                  (const :tag "Ledger" ledger)
174                  (const :tag "Lilypond" lilypond)
175                  (const :tag "Maxima" maxima)
176                  (const :tag "Matlab" matlab)
177                  (const :tag "Mscgen" mscgen)
178                  (const :tag "Ocaml" ocaml)
179                  (const :tag "Octave" octave)
180                  (const :tag "Org" org)
181                  (const :tag "Perl" perl)
182                  (const :tag "PlantUML" plantuml)
183                  (const :tag "Python" python)
184                  (const :tag "Ruby" ruby)
185                  (const :tag "Sass" sass)
186                  (const :tag "Scheme" scheme)
187                  (const :tag "Screen" screen)
188                  (const :tag "Shell Script" sh)
189                  (const :tag "Shen" shen)
190                  (const :tag "Sql" sql)
191                  (const :tag "Sqlite" sqlite))
192                 :value-type (boolean :tag "Activate" :value t)))
193
194 ;;;; Customization variables
195 (defcustom org-clone-delete-id nil
196   "Remove ID property of clones of a subtree.
197 When non-nil, clones of a subtree don't inherit the ID property.
198 Otherwise they inherit the ID property with a new unique
199 identifier."
200   :type 'boolean
201   :group 'org-id)
202
203 ;;; Version
204
205 (defconst org-version "7.7"
206   "The version number of the file org.el.")
207
208 (defun org-version (&optional here)
209   "Show the org-mode version in the echo area.
210 With prefix arg HERE, insert it at point."
211   (interactive "P")
212   (let* ((origin default-directory)
213          (version org-version)
214          (git-version)
215          (dir (concat (file-name-directory (locate-library "org")) "../" )))
216     (when (and (file-exists-p (expand-file-name ".git" dir))
217                (executable-find "git"))
218       (unwind-protect
219           (progn
220             (cd dir)
221             (when (eql 0 (shell-command "git describe --abbrev=4 HEAD"))
222               (with-current-buffer "*Shell Command Output*"
223                 (goto-char (point-min))
224                 (setq git-version (buffer-substring (point) (point-at-eol))))
225               (subst-char-in-string ?- ?. git-version t)
226               (when (string-match "\\S-"
227                                   (shell-command-to-string
228                                    "git diff-index --name-only HEAD --"))
229                 (setq git-version (concat git-version ".dirty")))
230               (setq version (concat version " (" git-version ")"))))
231         (cd origin)))
232     (setq version (format "Org-mode version %s" version))
233     (if here (insert version))
234     (message version)))
235
236 ;;; Compatibility constants
237
238 ;;; The custom variables
239
240 (defgroup org nil
241   "Outline-based notes management and organizer."
242   :tag "Org"
243   :group 'outlines
244   :group 'calendar)
245
246 (defcustom org-mode-hook nil
247   "Mode hook for Org-mode, run after the mode was turned on."
248   :group 'org
249   :type 'hook)
250
251 (defcustom org-load-hook nil
252   "Hook that is run after org.el has been loaded."
253   :group 'org
254   :type 'hook)
255
256 (defcustom org-log-buffer-setup-hook nil
257   "Hook that is run after an Org log buffer is created."
258   :group 'org
259   :type 'hook)
260
261 (defvar org-modules)  ; defined below
262 (defvar org-modules-loaded nil
263   "Have the modules been loaded already?")
264
265 (defun org-load-modules-maybe (&optional force)
266   "Load all extensions listed in `org-modules'."
267   (when (or force (not org-modules-loaded))
268     (mapc (lambda (ext)
269             (condition-case nil (require ext)
270               (error (message "Problems while trying to load feature `%s'" ext))))
271           org-modules)
272     (setq org-modules-loaded t)))
273
274 (defun org-set-modules (var value)
275   "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
276   (set var value)
277   (when (featurep 'org)
278     (org-load-modules-maybe 'force)))
279
280 (when (org-bound-and-true-p org-modules)
281   (let ((a (member 'org-infojs org-modules)))
282     (and a (setcar a 'org-jsinfo))))
283
284 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
285   "Modules that should always be loaded together with org.el.
286 If a description starts with <C>, the file is not part of Emacs
287 and loading it will require that you have downloaded and properly installed
288 the org-mode distribution.
289
290 You can also use this system to load external packages (i.e. neither Org
291 core modules, nor modules from the CONTRIB directory).  Just add symbols
292 to the end of the list.  If the package is called org-xyz.el, then you need
293 to add the symbol `xyz', and the package must have a call to
294
295    (provide 'org-xyz)"
296   :group 'org
297   :set 'org-set-modules
298   :type
299   '(set :greedy t
300         (const :tag "   bbdb:              Links to BBDB entries" org-bbdb)
301         (const :tag "   bibtex:            Links to BibTeX entries" org-bibtex)
302         (const :tag "   crypt:             Encryption of subtrees" org-crypt)
303         (const :tag "   ctags:             Access to Emacs tags with links" org-ctags)
304         (const :tag "   docview:           Links to doc-view buffers" org-docview)
305         (const :tag "   gnus:              Links to GNUS folders/messages" org-gnus)
306         (const :tag "   id:                Global IDs for identifying entries" org-id)
307         (const :tag "   info:              Links to Info nodes" org-info)
308         (const :tag "   jsinfo:            Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
309         (const :tag "   habit:             Track your consistency with habits" org-habit)
310         (const :tag "   inlinetask:        Tasks independent of outline hierarchy" org-inlinetask)
311         (const :tag "   irc:               Links to IRC/ERC chat sessions" org-irc)
312         (const :tag "   mac-message:       Links to messages in Apple Mail" org-mac-message)
313         (const :tag "   mew                Links to Mew folders/messages" org-mew)
314         (const :tag "   mhe:               Links to MHE folders/messages" org-mhe)
315         (const :tag "   protocol:          Intercept calls from emacsclient" org-protocol)
316         (const :tag "   rmail:             Links to RMAIL folders/messages" org-rmail)
317         (const :tag "   special-blocks:    Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
318         (const :tag "   vm:                Links to VM folders/messages" org-vm)
319         (const :tag "   wl:                Links to Wanderlust folders/messages" org-wl)
320         (const :tag "   w3m:               Special cut/paste from w3m to Org-mode." org-w3m)
321         (const :tag "   mouse:             Additional mouse support" org-mouse)
322         (const :tag "   TaskJuggler:       Export tasks to a TaskJuggler project" org-taskjuggler)
323
324         (const :tag "C  annotate-file:     Annotate a file with org syntax" org-annotate-file)
325         (const :tag "C  bookmark:          Org-mode links to bookmarks" org-bookmark)
326         (const :tag "C  checklist:         Extra functions for checklists in repeated tasks" org-checklist)
327         (const :tag "C  choose:            Use TODO keywords to mark decisions states" org-choose)
328         (const :tag "C  collector:         Collect properties into tables" org-collector)
329         (const :tag "C  depend:            TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
330         (const :tag "C  drill:             Flashcards and spaced repetition for Org-mode" org-drill)
331         (const :tag "C  elisp-symbol:      Org-mode links to emacs-lisp symbols" org-elisp-symbol)
332         (const :tag "C  eshell             Support for links to working directories in eshell" org-eshell)
333         (const :tag "C  eval:              Include command output as text" org-eval)
334         (const :tag "C  eval-light:        Evaluate inbuffer-code on demand" org-eval-light)
335         (const :tag "C  expiry:            Expiry mechanism for Org-mode entries" org-expiry)
336         (const :tag "C  exp-bibtex:        Export citations using BibTeX" org-exp-bibtex)
337         (const :tag "C  git-link:          Provide org links to specific file version" org-git-link)
338         (const :tag "C  interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
339
340         (const :tag "C  invoice:           Help manage client invoices in Org-mode" org-invoice)
341
342         (const :tag "C  jira:              Add a jira:ticket protocol to Org-mode" org-jira)
343         (const :tag "C  learn:             SuperMemo's incremental learning algorithm" org-learn)
344         (const :tag "C  mairix:            Hook mairix search into Org-mode for different MUAs" org-mairix)
345         (const :tag "C  notmuch:           Provide org links to notmuch searches or messages" org-notmuch)
346         (const :tag "C  mac-iCal           Imports events from iCal.app to the Emacs diary" org-mac-iCal)
347         (const :tag "C  mac-link-grabber   Grab links and URLs from various Mac applications" org-mac-link-grabber)
348         (const :tag "C  man:               Support for links to manpages in Org-mode" org-man)
349         (const :tag "C  mtags:             Support for muse-like tags" org-mtags)
350         (const :tag "C  odt:               OpenDocumentText exporter for Org-mode" org-odt)
351         (const :tag "C  panel:             Simple routines for us with bad memory" org-panel)
352         (const :tag "C  registry:          A registry for Org-mode links" org-registry)
353         (const :tag "C  org2rem:           Convert org appointments into reminders" org2rem)
354         (const :tag "C  screen:            Visit screen sessions through Org-mode links" org-screen)
355         (const :tag "C  secretary:         Team management with org-mode" org-secretary)
356         (const :tag "C  sqlinsert:         Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
357         (const :tag "C  toc:               Table of contents for Org-mode buffer" org-toc)
358         (const :tag "C  track:             Keep up with Org-mode development" org-track)
359         (const :tag "C  velocity           Something like Notational Velocity for Org" org-velocity)
360         (const :tag "C  wikinodes:         CamelCase wiki-like links" org-wikinodes)
361         (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
362
363 (defcustom org-support-shift-select nil
364   "Non-nil means make shift-cursor commands select text when possible.
365
366 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
367 start selecting a region, or enlarge regions started in this way.
368 In Org-mode, in special contexts, these same keys are used for
369 other purposes, important enough to compete with shift selection.
370 Org tries to balance these needs by supporting `shift-select-mode'
371 outside these special contexts, under control of this variable.
372
373 The default of this variable is nil, to avoid confusing behavior.  Shifted
374 cursor keys will then execute Org commands in the following contexts:
375 - on a headline, changing TODO state (left/right) and priority (up/down)
376 - on a time stamp, changing the time
377 - in a plain list item, changing the bullet type
378 - in a property definition line, switching between allowed values
379 - in the BEGIN line of a clock table (changing the time block).
380 Outside these contexts, the commands will throw an error.
381
382 When this variable is t and the cursor is not in a special
383 context, Org-mode will support shift-selection for making and
384 enlarging regions.  To make this more effective, the bullet
385 cycling will no longer happen anywhere in an item line, but only
386 if the cursor is exactly on the bullet.
387
388 If you set this variable to the symbol `always', then the keys
389 will not be special in headlines, property lines, and item lines,
390 to make shift selection work there as well.  If this is what you
391 want, you can use the following alternative commands: `C-c C-t'
392 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
393 can be used to switch TODO sets, `C-c -' to cycle item bullet
394 types, and properties can be edited by hand or in column view.
395
396 However, when the cursor is on a timestamp, shift-cursor commands
397 will still edit the time stamp - this is just too good to give up.
398
399 XEmacs user should have this variable set to nil, because
400 `shift-select-mode' is in Emacs 23 or later only."
401   :group 'org
402   :type '(choice
403           (const :tag "Never" nil)
404           (const :tag "When outside special context" t)
405           (const :tag "Everywhere except timestamps" always)))
406
407 (defcustom org-loop-over-headlines-in-active-region nil
408   "Shall some commands act upon headlines in the active region?
409
410 When set to `t', some commands will be performed in all headlines
411 within the active region.
412
413 When set to a string, those commands will be performed on the
414 matching headlines within the active region.  Such string must be
415 a tags/property/todo match as it is used in the agenda tags view.
416
417 The list of commands is:
418 - `org-schedule'
419 - `org-deadline'"
420   :type '(choice (const :tag "Don't loop" nil)
421                  (const :tag "All headlines in active region" t)
422                  (string :tag "Tags/Property/Todo matcher"))
423   :group 'org-todo
424   :group 'org-archive)
425
426 (defgroup org-startup nil
427   "Options concerning startup of Org-mode."
428   :tag "Org Startup"
429   :group 'org)
430
431 (defcustom org-startup-folded t
432   "Non-nil means entering Org-mode will switch to OVERVIEW.
433 This can also be configured on a per-file basis by adding one of
434 the following lines anywhere in the buffer:
435
436    #+STARTUP: fold              (or `overview', this is equivalent)
437    #+STARTUP: nofold            (or `showall', this is equivalent)
438    #+STARTUP: content
439    #+STARTUP: showeverything"
440   :group 'org-startup
441   :type '(choice
442           (const :tag "nofold: show all" nil)
443           (const :tag "fold: overview" t)
444           (const :tag "content: all headlines" content)
445           (const :tag "show everything, even drawers" showeverything)))
446
447 (defcustom org-startup-truncated t
448   "Non-nil means entering Org-mode will set `truncate-lines'.
449 This is useful since some lines containing links can be very long and
450 uninteresting.  Also tables look terrible when wrapped."
451   :group 'org-startup
452   :type 'boolean)
453
454 (defcustom org-startup-indented nil
455   "Non-nil means turn on `org-indent-mode' on startup.
456 This can also be configured on a per-file basis by adding one of
457 the following lines anywhere in the buffer:
458
459    #+STARTUP: indent
460    #+STARTUP: noindent"
461   :group 'org-structure
462   :type '(choice
463           (const :tag "Not" nil)
464           (const :tag "Globally (slow on startup in large files)" t)))
465
466 (defcustom org-use-sub-superscripts t
467   "Non-nil means interpret \"_\" and \"^\" for export.
468 When this option is turned on, you can use TeX-like syntax for sub- and
469 superscripts.  Several characters after \"_\" or \"^\" will be
470 considered as a single item - so grouping with {} is normally not
471 needed.  For example, the following things will be parsed as single
472 sub- or superscripts.
473
474  10^24   or   10^tau     several digits will be considered 1 item.
475  10^-12  or   10^-tau    a leading sign with digits or a word
476  x^2-y^3                 will be read as x^2 - y^3, because items are
477                          terminated by almost any nonword/nondigit char.
478  x_{i^2} or   x^(2-i)    braces or parenthesis do grouping.
479
480 Still, ambiguity is possible - so when in doubt use {} to enclose the
481 sub/superscript.  If you set this variable to the symbol `{}',
482 the braces are *required* in order to trigger interpretations as
483 sub/superscript.  This can be helpful in documents that need \"_\"
484 frequently in plain text.
485
486 Not all export backends support this, but HTML does.
487
488 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
489   :group 'org-startup
490   :group 'org-export-translation
491   :type '(choice
492           (const :tag "Always interpret" t)
493           (const :tag "Only with braces" {})
494           (const :tag "Never interpret" nil)))
495
496 (if (fboundp 'defvaralias)
497     (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
498
499
500 (defcustom org-startup-with-beamer-mode nil
501   "Non-nil means turn on `org-beamer-mode' on startup.
502 This can also be configured on a per-file basis by adding one of
503 the following lines anywhere in the buffer:
504
505    #+STARTUP: beamer"
506   :group 'org-startup
507   :type 'boolean)
508
509 (defcustom org-startup-align-all-tables nil
510   "Non-nil means align all tables when visiting a file.
511 This is useful when the column width in tables is forced with <N> cookies
512 in table fields.  Such tables will look correct only after the first re-align.
513 This can also be configured on a per-file basis by adding one of
514 the following lines anywhere in the buffer:
515    #+STARTUP: align
516    #+STARTUP: noalign"
517   :group 'org-startup
518   :type 'boolean)
519
520 (defcustom org-startup-with-inline-images nil
521   "Non-nil means show inline images when loading a new Org file.
522 This can also be configured on a per-file basis by adding one of
523 the following lines anywhere in the buffer:
524    #+STARTUP: inlineimages
525    #+STARTUP: noinlineimages"
526   :group 'org-startup
527   :type 'boolean)
528
529 (defcustom org-insert-mode-line-in-empty-file nil
530   "Non-nil means insert the first line setting Org-mode in empty files.
531 When the function `org-mode' is called interactively in an empty file, this
532 normally means that the file name does not automatically trigger Org-mode.
533 To ensure that the file will always be in Org-mode in the future, a
534 line enforcing Org-mode will be inserted into the buffer, if this option
535 has been set."
536   :group 'org-startup
537   :type 'boolean)
538
539 (defcustom org-replace-disputed-keys nil
540   "Non-nil means use alternative key bindings for some keys.
541 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
542 These keys are also used by other packages like shift-selection-mode'
543 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
544 If you want to use Org-mode together with one of these other modes,
545 or more generally if you would like to move some Org-mode commands to
546 other keys, set this variable and configure the keys with the variable
547 `org-disputed-keys'.
548
549 This option is only relevant at load-time of Org-mode, and must be set
550 *before* org.el is loaded.  Changing it requires a restart of Emacs to
551 become effective."
552   :group 'org-startup
553   :type 'boolean)
554
555 (defcustom org-use-extra-keys nil
556   "Non-nil means use extra key sequence definitions for certain commands.
557 This happens automatically if you run XEmacs or if `window-system'
558 is nil.  This variable lets you do the same manually.  You must
559 set it before loading org.
560
561 Example: on Carbon Emacs 22 running graphically, with an external
562 keyboard on a Powerbook, the default way of setting M-left might
563 not work for either Alt or ESC.  Setting this variable will make
564 it work for ESC."
565   :group 'org-startup
566   :type 'boolean)
567
568 (if (fboundp 'defvaralias)
569     (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
570
571 (defcustom org-disputed-keys
572   '(([(shift up)]               . [(meta p)])
573     ([(shift down)]             . [(meta n)])
574     ([(shift left)]             . [(meta -)])
575     ([(shift right)]            . [(meta +)])
576     ([(control shift right)]    . [(meta shift +)])
577     ([(control shift left)]     . [(meta shift -)]))
578   "Keys for which Org-mode and other modes compete.
579 This is an alist, cars are the default keys, second element specifies
580 the alternative to use when `org-replace-disputed-keys' is t.
581
582 Keys can be specified in any syntax supported by `define-key'.
583 The value of this option takes effect only at Org-mode's startup,
584 therefore you'll have to restart Emacs to apply it after changing."
585   :group 'org-startup
586   :type 'alist)
587
588 (defun org-key (key)
589   "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
590 Or return the original if not disputed.
591 Also apply the translations defined in `org-xemacs-key-equivalents'."
592   (when org-replace-disputed-keys
593     (let* ((nkey (key-description key))
594            (x (org-find-if (lambda (x)
595                              (equal (key-description (car x)) nkey))
596                            org-disputed-keys)))
597       (setq key (if x (cdr x) key))))
598   (when (featurep 'xemacs)
599     (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
600   key)
601
602 (defun org-find-if (predicate seq)
603   (catch 'exit
604     (while seq
605       (if (funcall predicate (car seq))
606           (throw 'exit (car seq))
607         (pop seq)))))
608
609 (defun org-defkey (keymap key def)
610   "Define a key, possibly translated, as returned by `org-key'."
611   (define-key keymap (org-key key) def))
612
613 (defcustom org-ellipsis nil
614   "The ellipsis to use in the Org-mode outline.
615 When nil, just use the standard three dots.  When a string, use that instead,
616 When a face, use the standard 3 dots, but with the specified face.
617 The change affects only Org-mode (which will then use its own display table).
618 Changing this requires executing `M-x org-mode' in a buffer to become
619 effective."
620   :group 'org-startup
621   :type '(choice (const :tag "Default" nil)
622                  (face :tag "Face" :value org-warning)
623                  (string :tag "String" :value "...#")))
624
625 (defvar org-display-table nil
626   "The display table for org-mode, in case `org-ellipsis' is non-nil.")
627
628 (defgroup org-keywords nil
629   "Keywords in Org-mode."
630   :tag "Org Keywords"
631   :group 'org)
632
633 (defcustom org-deadline-string "DEADLINE:"
634   "String to mark deadline entries.
635 A deadline is this string, followed by a time stamp.  Should be a word,
636 terminated by a colon.  You can insert a schedule keyword and
637 a timestamp with \\[org-deadline].
638 Changes become only effective after restarting Emacs."
639   :group 'org-keywords
640   :type 'string)
641
642 (defcustom org-scheduled-string "SCHEDULED:"
643   "String to mark scheduled TODO entries.
644 A schedule is this string, followed by a time stamp.  Should be a word,
645 terminated by a colon.  You can insert a schedule keyword and
646 a timestamp with \\[org-schedule].
647 Changes become only effective after restarting Emacs."
648   :group 'org-keywords
649   :type 'string)
650
651 (defcustom org-closed-string "CLOSED:"
652   "String used as the prefix for timestamps logging closing a TODO entry."
653   :group 'org-keywords
654   :type 'string)
655
656 (defcustom org-clock-string "CLOCK:"
657   "String used as prefix for timestamps clocking work hours on an item."
658   :group 'org-keywords
659   :type 'string)
660
661 (defcustom org-comment-string "COMMENT"
662   "Entries starting with this keyword will never be exported.
663 An entry can be toggled between COMMENT and normal with
664 \\[org-toggle-comment].
665 Changes become only effective after restarting Emacs."
666   :group 'org-keywords
667   :type 'string)
668
669 (defcustom org-quote-string "QUOTE"
670   "Entries starting with this keyword will be exported in fixed-width font.
671 Quoting applies only to the text in the entry following the headline, and does
672 not extend beyond the next headline, even if that is lower level.
673 An entry can be toggled between QUOTE and normal with
674 \\[org-toggle-fixed-width-section]."
675   :group 'org-keywords
676   :type 'string)
677
678 (defconst org-repeat-re
679   "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)"
680   "Regular expression for specifying repeated events.
681 After a match, group 1 contains the repeat expression.")
682
683 (defgroup org-structure nil
684   "Options concerning the general structure of Org-mode files."
685   :tag "Org Structure"
686   :group 'org)
687
688 (defgroup org-reveal-location nil
689   "Options about how to make context of a location visible."
690   :tag "Org Reveal Location"
691   :group 'org-structure)
692
693 (defconst org-context-choice
694   '(choice
695     (const :tag "Always" t)
696     (const :tag "Never" nil)
697     (repeat :greedy t :tag "Individual contexts"
698             (cons
699              (choice :tag "Context"
700                      (const agenda)
701                      (const org-goto)
702                      (const occur-tree)
703                      (const tags-tree)
704                      (const link-search)
705                      (const mark-goto)
706                      (const bookmark-jump)
707                      (const isearch)
708                      (const default))
709              (boolean))))
710   "Contexts for the reveal options.")
711
712 (defcustom org-show-hierarchy-above '((default . t))
713   "Non-nil means show full hierarchy when revealing a location.
714 Org-mode often shows locations in an org-mode file which might have
715 been invisible before.  When this is set, the hierarchy of headings
716 above the exposed location is shown.
717 Turning this off for example for sparse trees makes them very compact.
718 Instead of t, this can also be an alist specifying this option for different
719 contexts.  Valid contexts are
720   agenda         when exposing an entry from the agenda
721   org-goto       when using the command `org-goto' on key C-c C-j
722   occur-tree     when using the command `org-occur' on key C-c /
723   tags-tree      when constructing a sparse tree based on tags matches
724   link-search    when exposing search matches associated with a link
725   mark-goto      when exposing the jump goal of a mark
726   bookmark-jump  when exposing a bookmark location
727   isearch        when exiting from an incremental search
728   default        default for all contexts not set explicitly"
729   :group 'org-reveal-location
730   :type org-context-choice)
731
732 (defcustom org-show-following-heading '((default . nil))
733   "Non-nil means show following heading when revealing a location.
734 Org-mode often shows locations in an org-mode file which might have
735 been invisible before.  When this is set, the heading following the
736 match is shown.
737 Turning this off for example for sparse trees makes them very compact,
738 but makes it harder to edit the location of the match.  In such a case,
739 use the command \\[org-reveal] to show more context.
740 Instead of t, this can also be an alist specifying this option for different
741 contexts.  See `org-show-hierarchy-above' for valid contexts."
742   :group 'org-reveal-location
743   :type org-context-choice)
744
745 (defcustom org-show-siblings '((default . nil) (isearch t))
746   "Non-nil means show all sibling heading when revealing a location.
747 Org-mode often shows locations in an org-mode file which might have
748 been invisible before.  When this is set, the sibling of the current entry
749 heading are all made visible.  If `org-show-hierarchy-above' is t,
750 the same happens on each level of the hierarchy above the current entry.
751
752 By default this is on for the isearch context, off for all other contexts.
753 Turning this off for example for sparse trees makes them very compact,
754 but makes it harder to edit the location of the match.  In such a case,
755 use the command \\[org-reveal] to show more context.
756 Instead of t, this can also be an alist specifying this option for different
757 contexts.  See `org-show-hierarchy-above' for valid contexts."
758   :group 'org-reveal-location
759   :type org-context-choice)
760
761 (defcustom org-show-entry-below '((default . nil))
762   "Non-nil means show the entry below a headline when revealing a location.
763 Org-mode often shows locations in an org-mode file which might have
764 been invisible before.  When this is set, the text below the headline that is
765 exposed is also shown.
766
767 By default this is off for all contexts.
768 Instead of t, this can also be an alist specifying this option for different
769 contexts.  See `org-show-hierarchy-above' for valid contexts."
770   :group 'org-reveal-location
771   :type org-context-choice)
772
773 (defcustom org-indirect-buffer-display 'other-window
774   "How should indirect tree buffers be displayed?
775 This applies to indirect buffers created with the commands
776 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
777 Valid values are:
778 current-window   Display in the current window
779 other-window     Just display in another window.
780 dedicated-frame  Create one new frame, and re-use it each time.
781 new-frame        Make a new frame each time.  Note that in this case
782                  previously-made indirect buffers are kept, and you need to
783                  kill these buffers yourself."
784   :group 'org-structure
785   :group 'org-agenda-windows
786   :type '(choice
787           (const :tag "In current window" current-window)
788           (const :tag "In current frame, other window" other-window)
789           (const :tag "Each time a new frame" new-frame)
790           (const :tag "One dedicated frame" dedicated-frame)))
791
792 (defcustom org-use-speed-commands nil
793   "Non-nil means activate single letter commands at beginning of a headline.
794 This may also be a function to test for appropriate locations where speed
795 commands should be active."
796   :group 'org-structure
797   :type '(choice
798           (const :tag "Never" nil)
799           (const :tag "At beginning of headline stars" t)
800           (function)))
801
802 (defcustom org-speed-commands-user nil
803     "Alist of additional speed commands.
804 This list will be checked before `org-speed-commands-default'
805 when the variable `org-use-speed-commands' is non-nil
806 and when the cursor is at the beginning of a headline.
807 The car if each entry is a string with a single letter, which must
808 be assigned to `self-insert-command' in the global map.
809 The cdr is either a command to be called interactively, a function
810 to be called, or a form to be evaluated.
811 An entry that is just a list with a single string will be interpreted
812 as a descriptive headline that will be added when listing the speed
813 commands in the Help buffer using the `?' speed command."
814     :group 'org-structure
815     :type '(repeat :value ("k" . ignore)
816             (choice :value ("k" . ignore)
817              (list :tag "Descriptive Headline" (string :tag "Headline"))
818              (cons :tag "Letter and Command"
819               (string :tag "Command letter")
820               (choice
821                (function)
822                (sexp))))))
823
824 (defgroup org-cycle nil
825   "Options concerning visibility cycling in Org-mode."
826   :tag "Org Cycle"
827   :group 'org-structure)
828
829 (defcustom org-cycle-skip-children-state-if-no-children t
830   "Non-nil means skip CHILDREN state in entries that don't have any."
831   :group 'org-cycle
832   :type 'boolean)
833
834 (defcustom org-cycle-max-level nil
835   "Maximum level which should still be subject to visibility cycling.
836 Levels higher than this will, for cycling, be treated as text, not a headline.
837 When `org-odd-levels-only' is set, a value of N in this variable actually
838 means 2N-1 stars as the limiting headline.
839 When nil, cycle all levels.
840 Note that the limiting level of cycling is also influenced by
841 `org-inlinetask-min-level'.  When `org-cycle-max-level' is not set but
842 `org-inlinetask-min-level' is, cycling will be limited to levels one less
843 than its value."
844   :group 'org-cycle
845   :type '(choice
846           (const :tag "No limit" nil)
847           (integer :tag "Maximum level")))
848
849 (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
850   "Names of drawers.  Drawers are not opened by cycling on the headline above.
851 Drawers only open with a TAB on the drawer line itself.  A drawer looks like
852 this:
853    :DRAWERNAME:
854    .....
855    :END:
856 The drawer \"PROPERTIES\" is special for capturing properties through
857 the property API.
858
859 Drawers can be defined on the per-file basis with a line like:
860
861 #+DRAWERS: HIDDEN STATE PROPERTIES"
862   :group 'org-structure
863   :group 'org-cycle
864   :type '(repeat (string :tag "Drawer Name")))
865
866 (defcustom org-hide-block-startup nil
867   "Non-nil means entering Org-mode will fold all blocks.
868 This can also be set in on a per-file basis with
869
870 #+STARTUP: hideblocks
871 #+STARTUP: showblocks"
872   :group 'org-startup
873   :group 'org-cycle
874   :type 'boolean)
875
876 (defcustom org-cycle-global-at-bob nil
877   "Cycle globally if cursor is at beginning of buffer and not at a headline.
878 This makes it possible to do global cycling without having to use S-TAB or
879 \\[universal-argument] TAB.  For this special case to work, the first line \
880 of the buffer
881 must not be a headline - it may be empty or some other text.  When used in
882 this way, `org-cycle-hook' is disables temporarily, to make sure the
883 cursor stays at the beginning of the buffer.
884 When this option is nil, don't do anything special at the beginning
885 of the buffer."
886   :group 'org-cycle
887   :type 'boolean)
888
889 (defcustom org-cycle-level-after-item/entry-creation t
890   "Non-nil means cycle entry level or item indentation in new empty entries.
891
892 When the cursor is at the end of an empty headline, i.e with only stars
893 and maybe a TODO keyword, TAB will then switch the entry to become a child,
894 and then all possible ancestor states, before returning to the original state.
895 This makes data entry extremely fast:  M-RET to create a new headline,
896 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
897
898 When the cursor is at the end of an empty plain list item, one TAB will
899 make it a subitem, two or more tabs will back up to make this an item
900 higher up in the item hierarchy."
901   :group 'org-cycle
902   :type 'boolean)
903
904 (defcustom org-cycle-emulate-tab t
905   "Where should `org-cycle' emulate TAB.
906 nil         Never
907 white       Only in completely white lines
908 whitestart  Only at the beginning of lines, before the first non-white char
909 t           Everywhere except in headlines
910 exc-hl-bol  Everywhere except at the start of a headline
911 If TAB is used in a place where it does not emulate TAB, the current subtree
912 visibility is cycled."
913   :group 'org-cycle
914   :type '(choice (const :tag "Never" nil)
915                  (const :tag "Only in completely white lines" white)
916                  (const :tag "Before first char in a line" whitestart)
917                  (const :tag "Everywhere except in headlines" t)
918                  (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
919                  ))
920
921 (defcustom org-cycle-separator-lines 2
922   "Number of empty lines needed to keep an empty line between collapsed trees.
923 If you leave an empty line between the end of a subtree and the following
924 headline, this empty line is hidden when the subtree is folded.
925 Org-mode will leave (exactly) one empty line visible if the number of
926 empty lines is equal or larger to the number given in this variable.
927 So the default 2 means at least 2 empty lines after the end of a subtree
928 are needed to produce free space between a collapsed subtree and the
929 following headline.
930
931 If the number is negative, and the number of empty lines is at least -N,
932 all empty lines are shown.
933
934 Special case: when 0, never leave empty lines in collapsed view."
935   :group 'org-cycle
936   :type 'integer)
937 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
938
939 (defcustom org-pre-cycle-hook nil
940   "Hook that is run before visibility cycling is happening.
941 The function(s) in this hook must accept a single argument which indicates
942 the new state that will be set right after running this hook.  The
943 argument is a symbol.  Before a global state change, it can have the values
944 `overview', `content', or `all'.  Before a local state change, it can have
945 the values `folded', `children', or `subtree'."
946   :group 'org-cycle
947   :type 'hook)
948
949 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
950                             org-cycle-hide-drawers
951                             org-cycle-show-empty-lines
952                             org-optimize-window-after-visibility-change)
953   "Hook that is run after `org-cycle' has changed the buffer visibility.
954 The function(s) in this hook must accept a single argument which indicates
955 the new state that was set by the most recent `org-cycle' command.  The
956 argument is a symbol.  After a global state change, it can have the values
957 `overview', `content', or `all'.  After a local state change, it can have
958 the values `folded', `children', or `subtree'."
959   :group 'org-cycle
960   :type 'hook)
961
962 (defgroup org-edit-structure nil
963   "Options concerning structure editing in Org-mode."
964   :tag "Org Edit Structure"
965   :group 'org-structure)
966
967 (defcustom org-odd-levels-only nil
968   "Non-nil means skip even levels and only use odd levels for the outline.
969 This has the effect that two stars are being added/taken away in
970 promotion/demotion commands.  It also influences how levels are
971 handled by the exporters.
972 Changing it requires restart of `font-lock-mode' to become effective
973 for fontification also in regions already fontified.
974 You may also set this on a per-file basis by adding one of the following
975 lines to the buffer:
976
977    #+STARTUP: odd
978    #+STARTUP: oddeven"
979   :group 'org-edit-structure
980   :group 'org-appearance
981   :type 'boolean)
982
983 (defcustom org-adapt-indentation t
984   "Non-nil means adapt indentation to outline node level.
985
986 When this variable is set, Org assumes that you write outlines by
987 indenting text in each node to align with the headline (after the stars).
988 The following issues are influenced by this variable:
989
990 - When this is set and the *entire* text in an entry is indented, the
991   indentation is increased by one space in a demotion command, and
992   decreased by one in a promotion command.  If any line in the entry
993   body starts with text at column 0, indentation is not changed at all.
994
995 - Property drawers and planning information is inserted indented when
996   this variable s set.  When nil, they will not be indented.
997
998 - TAB indents a line relative to context.  The lines below a headline
999   will be indented when this variable is set.
1000
1001 Note that this is all about true indentation, by adding and removing
1002 space characters.  See also `org-indent.el' which does level-dependent
1003 indentation in a virtual way, i.e. at display time in Emacs."
1004   :group 'org-edit-structure
1005   :type 'boolean)
1006
1007 (defcustom org-special-ctrl-a/e nil
1008   "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1009
1010 When t, `C-a' will bring back the cursor to the beginning of the
1011 headline text, i.e. after the stars and after a possible TODO keyword.
1012 In an item, this will be the position after the bullet.
1013 When the cursor is already at that position, another `C-a' will bring
1014 it to the beginning of the line.
1015
1016 `C-e' will jump to the end of the headline, ignoring the presence of tags
1017 in the headline.  A second `C-e' will then jump to the true end of the
1018 line, after any tags.  This also means that, when this variable is
1019 non-nil, `C-e' also will never jump beyond the end of the heading of a
1020 folded section, i.e. not after the ellipses.
1021
1022 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1023 going to the true line boundary first.  Only a directly following, identical
1024 keypress will bring the cursor to the special positions.
1025
1026 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1027 set separately."
1028   :group 'org-edit-structure
1029   :type '(choice
1030           (const :tag "off" nil)
1031           (const :tag "on: after stars/bullet and before tags first" t)
1032           (const :tag "reversed: true line boundary first" reversed)
1033           (cons :tag "Set C-a and C-e separately"
1034                 (choice :tag "Special C-a"
1035                         (const :tag "off" nil)
1036                         (const :tag "on: after  stars/bullet first" t)
1037                         (const :tag "reversed: before stars/bullet first" reversed))
1038                 (choice :tag "Special C-e"
1039                         (const :tag "off" nil)
1040                         (const :tag "on: before tags first" t)
1041                         (const :tag "reversed: after tags first" reversed)))))
1042 (if (fboundp 'defvaralias)
1043     (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
1044
1045 (defcustom org-special-ctrl-k nil
1046   "Non-nil means `C-k' will behave specially in headlines.
1047 When nil, `C-k' will call the default `kill-line' command.
1048 When t, the following will happen while the cursor is in the headline:
1049
1050 - When the cursor is at the beginning of a headline, kill the entire
1051   line and possible the folded subtree below the line.
1052 - When in the middle of the headline text, kill the headline up to the tags.
1053 - When after the headline text, kill the tags."
1054   :group 'org-edit-structure
1055   :type 'boolean)
1056
1057 (defcustom org-ctrl-k-protect-subtree nil
1058   "Non-nil means, do not delete a hidden subtree with C-k.
1059 When set to the symbol `error', simply throw an error when C-k is
1060 used to kill (part-of) a headline that has hidden text behind it.
1061 Any other non-nil value will result in a query to the user, if it is
1062 OK to kill that hidden subtree.  When nil, kill without remorse."
1063   :group 'org-edit-structure
1064   :type '(choice
1065           (const :tag "Do not protect hidden subtrees" nil)
1066           (const :tag "Protect hidden subtrees with a security query" t)
1067           (const :tag "Never kill a hidden subtree with C-k" error)))
1068
1069 (defcustom org-catch-invisible-edits nil
1070   "Check if in invisible region before inserting or deleting a character.
1071 Valid values are:
1072
1073 nil              Do not check, so just do invisible edits.
1074 error            Throw an error and do nothing.
1075 show             Make point visible, and do the requested edit.
1076 show-and-error   Make point visible, then throw an error and abort the edit.
1077 smart            Make point visible, and do insertion/deletion if it is
1078                  adjacent to visible text and the change feels predictable.
1079                  Never delete a previously invisible character or add in the
1080                  middle or right after an invisible region.  Basically, this
1081                  allows insertion and backward-delete right before ellipses.
1082                  FIXME: maybe in this case we should not even show?"
1083   :group 'org-edit-structure
1084   :type '(choice
1085           (const :tag "Do not check" nil)
1086           (const :tag "Throw error when trying to edit" error)
1087           (const :tag "Unhide, but do not do the edit" show-and-error)
1088           (const :tag "Show invisible part and do the edit" show)
1089           (const :tag "Be smart and do the right thing" smart)))
1090
1091 (defcustom org-yank-folded-subtrees t
1092   "Non-nil means when yanking subtrees, fold them.
1093 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1094 it starts with a heading and all other headings in it are either children
1095 or siblings, then fold all the subtrees.  However, do this only if no
1096 text after the yank would be swallowed into a folded tree by this action."
1097   :group 'org-edit-structure
1098   :type 'boolean)
1099
1100 (defcustom org-yank-adjusted-subtrees nil
1101   "Non-nil means when yanking subtrees, adjust the level.
1102 With this setting, `org-paste-subtree' is used to insert the subtree, see
1103 this function for details."
1104   :group 'org-edit-structure
1105   :type 'boolean)
1106
1107 (defcustom org-M-RET-may-split-line '((default . t))
1108   "Non-nil means M-RET will split the line at the cursor position.
1109 When nil, it will go to the end of the line before making a
1110 new line.
1111 You may also set this option in a different way for different
1112 contexts.  Valid contexts are:
1113
1114 headline  when creating a new headline
1115 item      when creating a new item
1116 table     in a table field
1117 default   the value to be used for all contexts not explicitly
1118           customized"
1119   :group 'org-structure
1120   :group 'org-table
1121   :type '(choice
1122           (const :tag "Always" t)
1123           (const :tag "Never" nil)
1124           (repeat :greedy t :tag "Individual contexts"
1125                   (cons
1126                    (choice :tag "Context"
1127                            (const headline)
1128                            (const item)
1129                            (const table)
1130                            (const default))
1131                    (boolean)))))
1132
1133
1134 (defcustom org-insert-heading-respect-content nil
1135   "Non-nil means insert new headings after the current subtree.
1136 When nil, the new heading is created directly after the current line.
1137 The commands \\[org-insert-heading-respect-content] and
1138 \\[org-insert-todo-heading-respect-content] turn this variable on
1139 for the duration of the command."
1140   :group 'org-structure
1141   :type 'boolean)
1142
1143 (defcustom org-blank-before-new-entry '((heading . auto)
1144                                         (plain-list-item . auto))
1145   "Should `org-insert-heading' leave a blank line before new heading/item?
1146 The value is an alist, with `heading' and `plain-list-item' as CAR,
1147 and a boolean flag as CDR.  The cdr may also be the symbol `auto', in
1148 which case Org will look at the surrounding headings/items and try to
1149 make an intelligent decision whether to insert a blank line or not.
1150
1151 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1152 set, the setting here is ignored and no empty line is inserted, to avoid
1153 breaking the list structure."
1154   :group 'org-edit-structure
1155   :type '(list
1156           (cons (const heading)
1157                 (choice (const :tag "Never" nil)
1158                         (const :tag "Always" t)
1159                         (const :tag "Auto" auto)))
1160           (cons (const plain-list-item)
1161                 (choice (const :tag "Never" nil)
1162                         (const :tag "Always" t)
1163                         (const :tag "Auto" auto)))))
1164
1165 (defcustom org-insert-heading-hook nil
1166   "Hook being run after inserting a new heading."
1167   :group 'org-edit-structure
1168   :type 'hook)
1169
1170 (defcustom org-enable-fixed-width-editor t
1171   "Non-nil means lines starting with \":\" are treated as fixed-width.
1172 This currently only means they are never auto-wrapped.
1173 When nil, such lines will be treated like ordinary lines.
1174 See also the QUOTE keyword."
1175   :group 'org-edit-structure
1176   :type 'boolean)
1177
1178 (defcustom org-goto-auto-isearch t
1179   "Non-nil means typing characters in `org-goto' starts incremental search."
1180   :group 'org-edit-structure
1181   :type 'boolean)
1182
1183 (defgroup org-sparse-trees nil
1184   "Options concerning sparse trees in Org-mode."
1185   :tag "Org Sparse Trees"
1186   :group 'org-structure)
1187
1188 (defcustom org-highlight-sparse-tree-matches t
1189   "Non-nil means highlight all matches that define a sparse tree.
1190 The highlights will automatically disappear the next time the buffer is
1191 changed by an edit command."
1192   :group 'org-sparse-trees
1193   :type 'boolean)
1194
1195 (defcustom org-remove-highlights-with-change t
1196   "Non-nil means any change to the buffer will remove temporary highlights.
1197 Such highlights are created by `org-occur' and `org-clock-display'.
1198 When nil, `C-c C-c needs to be used to get rid of the highlights.
1199 The highlights created by `org-preview-latex-fragment' always need
1200 `C-c C-c' to be removed."
1201   :group 'org-sparse-trees
1202   :group 'org-time
1203   :type 'boolean)
1204
1205
1206 (defcustom org-occur-hook '(org-first-headline-recenter)
1207   "Hook that is run after `org-occur' has constructed a sparse tree.
1208 This can be used to recenter the window to show as much of the structure
1209 as possible."
1210   :group 'org-sparse-trees
1211   :type 'hook)
1212
1213 (defgroup org-imenu-and-speedbar nil
1214   "Options concerning imenu and speedbar in Org-mode."
1215   :tag "Org Imenu and Speedbar"
1216   :group 'org-structure)
1217
1218 (defcustom org-imenu-depth 2
1219   "The maximum level for Imenu access to Org-mode headlines.
1220 This also applied for speedbar access."
1221   :group 'org-imenu-and-speedbar
1222   :type 'integer)
1223
1224 (defgroup org-table nil
1225   "Options concerning tables in Org-mode."
1226   :tag "Org Table"
1227   :group 'org)
1228
1229 (defcustom org-enable-table-editor 'optimized
1230   "Non-nil means lines starting with \"|\" are handled by the table editor.
1231 When nil, such lines will be treated like ordinary lines.
1232
1233 When equal to the symbol `optimized', the table editor will be optimized to
1234 do the following:
1235 - Automatic overwrite mode in front of whitespace in table fields.
1236   This makes the structure of the table stay in tact as long as the edited
1237   field does not exceed the column width.
1238 - Minimize the number of realigns.  Normally, the table is aligned each time
1239   TAB or RET are pressed to move to another field.  With optimization this
1240   happens only if changes to a field might have changed the column width.
1241 Optimization requires replacing the functions `self-insert-command',
1242 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1243 slight (in fact: unnoticeable) speed impact for normal typing.  Org-mode is
1244 very good at guessing when a re-align will be necessary, but you can always
1245 force one with \\[org-ctrl-c-ctrl-c].
1246
1247 If you would like to use the optimized version in Org-mode, but the
1248 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1249
1250 This variable can be used to turn on and off the table editor during a session,
1251 but in order to toggle optimization, a restart is required.
1252
1253 See also the variable `org-table-auto-blank-field'."
1254   :group 'org-table
1255   :type '(choice
1256           (const :tag "off" nil)
1257           (const :tag "on" t)
1258           (const :tag "on, optimized" optimized)))
1259
1260 (defcustom org-self-insert-cluster-for-undo t
1261   "Non-nil means cluster self-insert commands for undo when possible.
1262 If this is set, then, like in the Emacs command loop, 20 consecutive
1263 characters will be undone together.
1264 This is configurable, because there is some impact on typing performance."
1265   :group 'org-table
1266   :type 'boolean)
1267
1268 (defcustom org-table-tab-recognizes-table.el t
1269   "Non-nil means TAB will automatically notice a table.el table.
1270 When it sees such a table, it moves point into it and - if necessary -
1271 calls `table-recognize-table'."
1272   :group 'org-table-editing
1273   :type 'boolean)
1274
1275 (defgroup org-link nil
1276   "Options concerning links in Org-mode."
1277   :tag "Org Link"
1278   :group 'org)
1279
1280 (defvar org-link-abbrev-alist-local nil
1281   "Buffer-local version of `org-link-abbrev-alist', which see.
1282 The value of this is taken from the #+LINK lines.")
1283 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1284
1285 (defcustom org-link-abbrev-alist nil
1286   "Alist of link abbreviations.
1287 The car of each element is a string, to be replaced at the start of a link.
1288 The cdrs are replacement values, like (\"linkkey\" . REPLACE).  Abbreviated
1289 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1290
1291      [[linkkey:tag][description]]
1292
1293 The 'linkkey' must be a word word, starting with a letter, followed
1294 by letters, numbers, '-' or '_'.
1295
1296 If REPLACE is a string, the tag will simply be appended to create the link.
1297 If the string contains \"%s\", the tag will be inserted there.  Alternatively,
1298 the placeholder \"%h\" will cause a url-encoded version of the tag to
1299 be inserted at that point (see the function `url-hexify-string').
1300
1301 REPLACE may also be a function that will be called with the tag as the
1302 only argument to create the link, which should be returned as a string.
1303
1304 See the manual for examples."
1305   :group 'org-link
1306   :type '(repeat
1307           (cons
1308            (string :tag "Protocol")
1309            (choice
1310             (string :tag "Format")
1311             (function)))))
1312
1313 (defcustom org-descriptive-links t
1314   "Non-nil means Org will display descriptive links.
1315 E.g. [[http://orgmode.org][Org website]] will be displayed as
1316 \"Org Website\", hiding the link itself and just displaying its
1317 description.  When set to `nil', Org will display the full links
1318 literally.
1319
1320 You can interactively set the value of this variable by calling
1321 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1322   :group 'org-link
1323   :type 'boolean)
1324
1325 (defcustom org-link-file-path-type 'adaptive
1326   "How the path name in file links should be stored.
1327 Valid values are:
1328
1329 relative  Relative to the current directory, i.e. the directory of the file
1330           into which the link is being inserted.
1331 absolute  Absolute path, if possible with ~ for home directory.
1332 noabbrev  Absolute path, no abbreviation of home directory.
1333 adaptive  Use relative path for files in the current directory and sub-
1334           directories of it.  For other files, use an absolute path."
1335   :group 'org-link
1336   :type '(choice
1337           (const relative)
1338           (const absolute)
1339           (const noabbrev)
1340           (const adaptive)))
1341
1342 (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
1343   "Types of links that should be activated in Org-mode files.
1344 This is a list of symbols, each leading to the activation of a certain link
1345 type.  In principle, it does not hurt to turn on most link types - there may
1346 be a small gain when turning off unused link types.  The types are:
1347
1348 bracket   The recommended [[link][description]] or [[link]] links with hiding.
1349 angle     Links in angular brackets that may contain whitespace like
1350           <bbdb:Carsten Dominik>.
1351 plain     Plain links in normal text, no whitespace, like http://google.com.
1352 radio     Text that is matched by a radio target, see manual for details.
1353 tag       Tag settings in a headline (link to tag search).
1354 date      Time stamps (link to calendar).
1355 footnote  Footnote labels.
1356
1357 Changing this variable requires a restart of Emacs to become effective."
1358   :group 'org-link
1359   :type '(set :greedy t
1360               (const :tag "Double bracket links" bracket)
1361               (const :tag "Angular bracket links" angle)
1362               (const :tag "Plain text links" plain)
1363               (const :tag "Radio target matches" radio)
1364               (const :tag "Tags" tag)
1365               (const :tag "Timestamps" date)
1366               (const :tag "Footnotes" footnote)))
1367
1368 (defcustom org-make-link-description-function nil
1369   "Function to use to generate link descriptions from links.
1370 If nil the link location will be used.  This function must take
1371 two parameters; the first is the link and the second the
1372 description `org-insert-link' has generated, and should return the
1373 description to use."
1374   :group 'org-link
1375   :type 'function)
1376
1377 (defgroup org-link-store nil
1378   "Options concerning storing links in Org-mode."
1379   :tag "Org Store Link"
1380   :group 'org-link)
1381
1382 (defcustom org-email-link-description-format "Email %c: %.30s"
1383   "Format of the description part of a link to an email or usenet message.
1384 The following %-escapes will be replaced by corresponding information:
1385
1386 %F   full \"From\" field
1387 %f   name, taken from \"From\" field, address if no name
1388 %T   full \"To\" field
1389 %t   first name in \"To\" field, address if no name
1390 %c   correspondent.  Usually \"from NAME\", but if you sent it yourself, it
1391      will be \"to NAME\".  See also the variable `org-from-is-user-regexp'.
1392 %s   subject
1393 %d   date
1394 %m   message-id.
1395
1396 You may use normal field width specification between the % and the letter.
1397 This is for example useful to limit the length of the subject.
1398
1399 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1400   :group 'org-link-store
1401   :type 'string)
1402
1403 (defcustom org-from-is-user-regexp
1404   (let (r1 r2)
1405     (when (and user-mail-address (not (string= user-mail-address "")))
1406       (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1407     (when (and user-full-name (not (string= user-full-name "")))
1408       (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1409     (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1410   "Regexp matched against the \"From:\" header of an email or usenet message.
1411 It should match if the message is from the user him/herself."
1412   :group 'org-link-store
1413   :type 'regexp)
1414
1415 (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
1416   "Non-nil means storing a link to an Org file will use entry IDs.
1417
1418 Note that before this variable is even considered, org-id must be loaded,
1419 so please customize `org-modules' and turn it on.
1420
1421 The variable can have the following values:
1422
1423 t     Create an ID if needed to make a link to the current entry.
1424
1425 create-if-interactive
1426       If `org-store-link' is called directly (interactively, as a user
1427       command), do create an ID to support the link.  But when doing the
1428       job for remember, only use the ID if it already exists.  The
1429       purpose of this setting is to avoid proliferation of unwanted
1430       IDs, just because you happen to be in an Org file when you
1431       call `org-remember' that automatically and preemptively
1432       creates a link.  If you do want to get an ID link in a remember
1433       template to an entry not having an ID, create it first by
1434       explicitly creating a link to it, using `C-c C-l' first.
1435
1436 create-if-interactive-and-no-custom-id
1437       Like create-if-interactive, but do not create an ID if there is
1438       a CUSTOM_ID property defined in the entry.  This is the default.
1439
1440 use-existing
1441       Use existing ID, do not create one.
1442
1443 nil   Never use an ID to make a link, instead link using a text search for
1444       the headline text."
1445   :group 'org-link-store
1446   :type '(choice
1447           (const :tag "Create ID to make link" t)
1448           (const :tag "Create if storing link interactively"
1449                  create-if-interactive)
1450           (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
1451                  create-if-interactive-and-no-custom-id)
1452           (const :tag "Only use existing" use-existing)
1453           (const :tag "Do not use ID to create link" nil)))
1454
1455 (defcustom org-context-in-file-links t
1456   "Non-nil means file links from `org-store-link' contain context.
1457 A search string will be added to the file name with :: as separator and
1458 used to find the context when the link is activated by the command
1459 `org-open-at-point'.  When this option is t, the entire active region
1460 will be placed in the search string of the file link.  If set to a
1461 positive integer, only the first n lines of context will be stored.
1462
1463 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1464 negates this setting for the duration of the command."
1465   :group 'org-link-store
1466   :type '(choice boolean integer))
1467
1468 (defcustom org-keep-stored-link-after-insertion nil
1469   "Non-nil means keep link in list for entire session.
1470
1471 The command `org-store-link' adds a link pointing to the current
1472 location to an internal list.  These links accumulate during a session.
1473 The command `org-insert-link' can be used to insert links into any
1474 Org-mode file (offering completion for all stored links).  When this
1475 option is nil, every link which has been inserted once using \\[org-insert-link]
1476 will be removed from the list, to make completing the unused links
1477 more efficient."
1478   :group 'org-link-store
1479   :type 'boolean)
1480
1481 (defgroup org-link-follow nil
1482   "Options concerning following links in Org-mode."
1483   :tag "Org Follow Link"
1484   :group 'org-link)
1485
1486 (defcustom org-link-translation-function nil
1487   "Function to translate links with different syntax to Org syntax.
1488 This can be used to translate links created for example by the Planner
1489 or emacs-wiki packages to Org syntax.
1490 The function must accept two parameters, a TYPE containing the link
1491 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1492 which is everything after the link protocol.  It should return a cons
1493 with possibly modified values of type and path.
1494 Org contains a function for this, so if you set this variable to
1495 `org-translate-link-from-planner', you should be able follow many
1496 links created by planner."
1497   :group 'org-link-follow
1498   :type 'function)
1499
1500 (defcustom org-follow-link-hook nil
1501   "Hook that is run after a link has been followed."
1502   :group 'org-link-follow
1503   :type 'hook)
1504
1505 (defcustom org-tab-follows-link nil
1506   "Non-nil means on links TAB will follow the link.
1507 Needs to be set before org.el is loaded.
1508 This really should not be used, it does not make sense, and the
1509 implementation is bad."
1510   :group 'org-link-follow
1511   :type 'boolean)
1512
1513 (defcustom org-return-follows-link nil
1514   "Non-nil means on links RET will follow the link."
1515   :group 'org-link-follow
1516   :type 'boolean)
1517
1518 (defcustom org-mouse-1-follows-link
1519   (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1520   "Non-nil means mouse-1 on a link will follow the link.
1521 A longer mouse click will still set point.  Does not work on XEmacs.
1522 Needs to be set before org.el is loaded."
1523   :group 'org-link-follow
1524   :type 'boolean)
1525
1526 (defcustom org-mark-ring-length 4
1527   "Number of different positions to be recorded in the ring.
1528 Changing this requires a restart of Emacs to work correctly."
1529   :group 'org-link-follow
1530   :type 'integer)
1531
1532 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1533   "Non-nil means internal links in Org files must exactly match a headline.
1534 When nil, the link search tries to match a phrase with all words
1535 in the search text."
1536   :group 'org-link-follow
1537   :type '(choice
1538           (const :tag "Use fuzzy text search" nil)
1539           (const :tag "Match only exact headline" t)
1540           (const :tag "Match exact headline or query to create it"
1541                  query-to-create)))
1542
1543 (defcustom org-link-frame-setup
1544   '((vm . vm-visit-folder-other-frame)
1545     (gnus . org-gnus-no-new-news)
1546     (file . find-file-other-window)
1547     (wl . wl-other-frame))
1548   "Setup the frame configuration for following links.
1549 When following a link with Emacs, it may often be useful to display
1550 this link in another window or frame.  This variable can be used to
1551 set this up for the different types of links.
1552 For VM, use any of
1553     `vm-visit-folder'
1554     `vm-visit-folder-other-window'
1555     `vm-visit-folder-other-frame'
1556 For Gnus, use any of
1557     `gnus'
1558     `gnus-other-frame'
1559     `org-gnus-no-new-news'
1560 For FILE, use any of
1561     `find-file'
1562     `find-file-other-window'
1563     `find-file-other-frame'
1564 For Wanderlust use any of
1565     `wl'
1566     `wl-other-frame'
1567 For the calendar, use the variable `calendar-setup'.
1568 For BBDB, it is currently only possible to display the matches in
1569 another window."
1570   :group 'org-link-follow
1571   :type '(list
1572           (cons (const vm)
1573                 (choice
1574                  (const vm-visit-folder)
1575                  (const vm-visit-folder-other-window)
1576                  (const vm-visit-folder-other-frame)))
1577           (cons (const gnus)
1578                 (choice
1579                  (const gnus)
1580                  (const gnus-other-frame)
1581                  (const org-gnus-no-new-news)))
1582           (cons (const file)
1583                 (choice
1584                  (const find-file)
1585                  (const find-file-other-window)
1586                  (const find-file-other-frame)))
1587           (cons (const wl)
1588                 (choice
1589                  (const wl)
1590                  (const wl-other-frame)))))
1591
1592 (defcustom org-display-internal-link-with-indirect-buffer nil
1593   "Non-nil means use indirect buffer to display infile links.
1594 Activating internal links (from one location in a file to another location
1595 in the same file) normally just jumps to the location.  When the link is
1596 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1597 is displayed in
1598 another window.  When this option is set, the other window actually displays
1599 an indirect buffer clone of the current buffer, to avoid any visibility
1600 changes to the current buffer."
1601   :group 'org-link-follow
1602   :type 'boolean)
1603
1604 (defcustom org-open-non-existing-files nil
1605   "Non-nil means `org-open-file' will open non-existing files.
1606 When nil, an error will be generated.
1607 This variable applies only to external applications because they
1608 might choke on non-existing files.  If the link is to a file that
1609 will be opened in Emacs, the variable is ignored."
1610   :group 'org-link-follow
1611   :type 'boolean)
1612
1613 (defcustom org-open-directory-means-index-dot-org nil
1614   "Non-nil means a link to a directory really means to index.org.
1615 When nil, following a directory link will run dired or open a finder/explorer
1616 window on that directory."
1617   :group 'org-link-follow
1618   :type 'boolean)
1619
1620 (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
1621   "Function and arguments to call for following mailto links.
1622 This is a list with the first element being a Lisp function, and the
1623 remaining elements being arguments to the function.  In string arguments,
1624 %a will be replaced by the address, and %s will be replaced by the subject
1625 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1626   :group 'org-link-follow
1627   :type '(choice
1628           (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
1629           (const :tag "compose-mail" (compose-mail "%a" "%s"))
1630           (const :tag "message-mail" (message-mail "%a" "%s"))
1631           (cons :tag "other" (function) (repeat :tag "argument" sexp))))
1632
1633 (defcustom org-confirm-shell-link-function 'yes-or-no-p
1634   "Non-nil means ask for confirmation before executing shell links.
1635 Shell links can be dangerous: just think about a link
1636
1637      [[shell:rm -rf ~/*][Google Search]]
1638
1639 This link would show up in your Org-mode document as \"Google Search\",
1640 but really it would remove your entire home directory.
1641 Therefore we advise against setting this variable to nil.
1642 Just change it to `y-or-n-p' if you want to confirm with a
1643 single keystroke rather than having to type \"yes\"."
1644   :group 'org-link-follow
1645   :type '(choice
1646           (const :tag "with yes-or-no (safer)" yes-or-no-p)
1647           (const :tag "with y-or-n (faster)" y-or-n-p)
1648           (const :tag "no confirmation (dangerous)" nil)))
1649 (put 'org-confirm-shell-link-function
1650      'safe-local-variable
1651      #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1652
1653 (defcustom org-confirm-shell-link-not-regexp ""
1654   "A regexp to skip confirmation for shell links."
1655   :group 'org-link-follow
1656   :type 'regexp)
1657
1658 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
1659   "Non-nil means ask for confirmation before executing Emacs Lisp links.
1660 Elisp links can be dangerous: just think about a link
1661
1662      [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
1663
1664 This link would show up in your Org-mode document as \"Google Search\",
1665 but really it would remove your entire home directory.
1666 Therefore we advise against setting this variable to nil.
1667 Just change it to `y-or-n-p' if you want to confirm with a
1668 single keystroke rather than having to type \"yes\"."
1669   :group 'org-link-follow
1670   :type '(choice
1671           (const :tag "with yes-or-no (safer)" yes-or-no-p)
1672           (const :tag "with y-or-n (faster)" y-or-n-p)
1673           (const :tag "no confirmation (dangerous)" nil)))
1674 (put 'org-confirm-shell-link-function
1675      'safe-local-variable
1676      #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1677
1678 (defcustom org-confirm-elisp-link-not-regexp ""
1679   "A regexp to skip confirmation for Elisp links."
1680   :group 'org-link-follow
1681   :type 'regexp)
1682
1683 (defconst org-file-apps-defaults-gnu
1684   '((remote . emacs)
1685     (system . mailcap)
1686     (t . mailcap))
1687   "Default file applications on a UNIX or GNU/Linux system.
1688 See `org-file-apps'.")
1689
1690 (defconst org-file-apps-defaults-macosx
1691   '((remote . emacs)
1692     (t . "open %s")
1693     (system . "open %s")
1694     ("ps.gz"  . "gv %s")
1695     ("eps.gz" . "gv %s")
1696     ("dvi"    . "xdvi %s")
1697     ("fig"    . "xfig %s"))
1698   "Default file applications on a MacOS X system.
1699 The system \"open\" is known as a default, but we use X11 applications
1700 for some files for which the OS does not have a good default.
1701 See `org-file-apps'.")
1702
1703 (defconst org-file-apps-defaults-windowsnt
1704   (list
1705    '(remote . emacs)
1706    (cons t
1707          (list (if (featurep 'xemacs)
1708                    'mswindows-shell-execute
1709                  'w32-shell-execute)
1710                "open" 'file))
1711    (cons 'system
1712          (list (if (featurep 'xemacs)
1713                    'mswindows-shell-execute
1714                  'w32-shell-execute)
1715                "open" 'file)))
1716   "Default file applications on a Windows NT system.
1717 The system \"open\" is used for most files.
1718 See `org-file-apps'.")
1719
1720 (defcustom org-file-apps
1721   '(
1722     (auto-mode . emacs)
1723     ("\\.mm\\'" . default)
1724     ("\\.x?html?\\'" . default)
1725     ("\\.pdf\\'" . default)
1726     )
1727   "External applications for opening `file:path' items in a document.
1728 Org-mode uses system defaults for different file types, but
1729 you can use this variable to set the application for a given file
1730 extension.  The entries in this list are cons cells where the car identifies
1731 files and the cdr the corresponding command.  Possible values for the
1732 file identifier are
1733  \"string\"    A string as a file identifier can be interpreted in different
1734                ways, depending on its contents:
1735
1736                - Alphanumeric characters only:
1737                  Match links with this file extension.
1738                  Example: (\"pdf\" . \"evince %s\")
1739                           to open PDFs with evince.
1740
1741                - Regular expression: Match links where the
1742                  filename matches the regexp.  If you want to
1743                  use groups here, use shy groups.
1744
1745                  Example: (\"\\.x?html\\'\" . \"firefox %s\")
1746                           (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
1747                           to open *.html and *.xhtml with firefox.
1748
1749                - Regular expression which contains (non-shy) groups:
1750                  Match links where the whole link, including \"::\", and
1751                  anything after that, matches the regexp.
1752                  In a custom command string, %1, %2, etc. are replaced with
1753                  the parts of the link that were matched by the groups.
1754                  For backwards compatibility, if a command string is given
1755                  that does not use any of the group matches, this case is
1756                  handled identically to the second one (i.e. match against
1757                  file name only).
1758                  In a custom lisp form, you can access the group matches with
1759                  (match-string n link).
1760
1761                  Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
1762                      to open [[file:document.pdf::5]] with evince at page 5.
1763
1764  `directory'   Matches a directory
1765  `remote'      Matches a remote file, accessible through tramp or efs.
1766                Remote files most likely should be visited through Emacs
1767                because external applications cannot handle such paths.
1768 `auto-mode'    Matches files that are matched by any entry in `auto-mode-alist',
1769                so all files Emacs knows how to handle.  Using this with
1770                command `emacs' will open most files in Emacs.  Beware that this
1771                will also open html files inside Emacs, unless you add
1772                (\"html\" . default) to the list as well.
1773  t             Default for files not matched by any of the other options.
1774  `system'      The system command to open files, like `open' on Windows
1775                and Mac OS X, and mailcap under GNU/Linux.  This is the command
1776                that will be selected if you call `C-c C-o' with a double
1777                \\[universal-argument] \\[universal-argument] prefix.
1778
1779 Possible values for the command are:
1780  `emacs'       The file will be visited by the current Emacs process.
1781  `default'     Use the default application for this file type, which is the
1782                association for t in the list, most likely in the system-specific
1783                part.
1784                This can be used to overrule an unwanted setting in the
1785                system-specific variable.
1786  `system'      Use the system command for opening files, like \"open\".
1787                This command is specified by the entry whose car is `system'.
1788                Most likely, the system-specific version of this variable
1789                does define this command, but you can overrule/replace it
1790                here.
1791  string        A command to be executed by a shell; %s will be replaced
1792                by the path to the file.
1793  sexp          A Lisp form which will be evaluated.  The file path will
1794                be available in the Lisp variable `file'.
1795 For more examples, see the system specific constants
1796 `org-file-apps-defaults-macosx'
1797 `org-file-apps-defaults-windowsnt'
1798 `org-file-apps-defaults-gnu'."
1799   :group 'org-link-follow
1800   :type '(repeat
1801           (cons (choice :value ""
1802                         (string :tag "Extension")
1803                         (const :tag "System command to open files" system)
1804                         (const :tag "Default for unrecognized files" t)
1805                         (const :tag "Remote file" remote)
1806                         (const :tag "Links to a directory" directory)
1807                         (const :tag "Any files that have Emacs modes"
1808                                auto-mode))
1809                 (choice :value ""
1810                         (const :tag "Visit with Emacs" emacs)
1811                         (const :tag "Use default" default)
1812                         (const :tag "Use the system command" system)
1813                         (string :tag "Command")
1814                         (sexp :tag "Lisp form")))))
1815
1816
1817
1818 (defgroup org-refile nil
1819   "Options concerning refiling entries in Org-mode."
1820   :tag "Org Refile"
1821   :group 'org)
1822
1823 (defcustom org-directory "~/org"
1824   "Directory with org files.
1825 This is just a default location to look for Org files.  There is no need
1826 at all to put your files into this directory.  It is only used in the
1827 following situations:
1828
1829 1. When a remember template specifies a target file that is not an
1830    absolute path.  The path will then be interpreted relative to
1831    `org-directory'
1832 2. When a remember note is filed away in an interactive way (when exiting the
1833    note buffer with `C-1 C-c C-c'.  The user is prompted for an org file,
1834    with `org-directory' as the default path."
1835   :group 'org-refile
1836   :group 'org-remember
1837   :type 'directory)
1838
1839 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
1840   "Default target for storing notes.
1841 Used as a fall back file for org-remember.el and org-capture.el, for
1842 templates that do not specify a target file."
1843   :group 'org-refile
1844   :group 'org-remember
1845   :type '(choice
1846           (const :tag "Default from remember-data-file" nil)
1847           file))
1848
1849 (defcustom org-goto-interface 'outline
1850   "The default interface to be used for `org-goto'.
1851 Allowed values are:
1852 outline                  The interface shows an outline of the relevant file
1853                          and the correct heading is found by moving through
1854                          the outline or by searching with incremental search.
1855 outline-path-completion  Headlines in the current buffer are offered via
1856                          completion.  This is the interface also used by
1857                          the refile command."
1858   :group 'org-refile
1859   :type '(choice
1860           (const :tag "Outline" outline)
1861           (const :tag "Outline-path-completion" outline-path-completion)))
1862
1863 (defcustom org-goto-max-level 5
1864   "Maximum target level when running `org-goto' with refile interface."
1865   :group 'org-refile
1866   :type 'integer)
1867
1868 (defcustom org-reverse-note-order nil
1869   "Non-nil means store new notes at the beginning of a file or entry.
1870 When nil, new notes will be filed to the end of a file or entry.
1871 This can also be a list with cons cells of regular expressions that
1872 are matched against file names, and values."
1873   :group 'org-remember
1874   :group 'org-refile
1875   :type '(choice
1876           (const :tag "Reverse always" t)
1877           (const :tag "Reverse never" nil)
1878           (repeat :tag "By file name regexp"
1879                   (cons regexp boolean))))
1880
1881 (defcustom org-log-refile nil
1882   "Information to record when a task is refiled.
1883
1884 Possible values are:
1885
1886 nil     Don't add anything
1887 time    Add a time stamp to the task
1888 note    Prompt for a note and add it with template `org-log-note-headings'
1889
1890 This option can also be set with on a per-file-basis with
1891
1892    #+STARTUP: nologrefile
1893    #+STARTUP: logrefile
1894    #+STARTUP: lognoterefile
1895
1896 You can have local logging settings for a subtree by setting the LOGGING
1897 property to one or more of these keywords.
1898
1899 When bulk-refiling from the agenda, the value `note' is forbidden and
1900 will temporarily be changed to `time'."
1901   :group 'org-refile
1902   :group 'org-progress
1903   :type '(choice
1904           (const :tag "No logging" nil)
1905           (const :tag "Record timestamp" time)
1906           (const :tag "Record timestamp with note." note)))
1907
1908 (defcustom org-refile-targets nil
1909   "Targets for refiling entries with \\[org-refile].
1910 This is a list of cons cells.  Each cell contains:
1911 - a specification of the files to be considered, either a list of files,
1912   or a symbol whose function or variable value will be used to retrieve
1913   a file name or a list of file names.  If you use `org-agenda-files' for
1914   that, all agenda files will be scanned for targets.  Nil means consider
1915   headings in the current buffer.
1916 - A specification of how to find candidate refile targets.  This may be
1917   any of:
1918   - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
1919     This tag has to be present in all target headlines, inheritance will
1920     not be considered.
1921   - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
1922     todo keyword.
1923   - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
1924     headlines that are refiling targets.
1925   - a cons cell (:level . N).  Any headline of level N is considered a target.
1926     Note that, when `org-odd-levels-only' is set, level corresponds to
1927     order in hierarchy, not to the number of stars.
1928   - a cons cell (:maxlevel . N).  Any headline with level <= N is a target.
1929     Note that, when `org-odd-levels-only' is set, level corresponds to
1930     order in hierarchy, not to the number of stars.
1931
1932 Each element of this list generates a set of possible targets.
1933 The union of these sets is presented (with completion) to
1934 the user by `org-refile'.
1935
1936 You can set the variable `org-refile-target-verify-function' to a function
1937 to verify each headline found by the simple criteria above.
1938
1939 When this variable is nil, all top-level headlines in the current buffer
1940 are used, equivalent to the value `((nil . (:level . 1))'."
1941   :group 'org-refile
1942   :type '(repeat
1943           (cons
1944            (choice :value org-agenda-files
1945                    (const :tag "All agenda files" org-agenda-files)
1946                    (const :tag "Current buffer" nil)
1947                    (function) (variable) (file))
1948            (choice :tag "Identify target headline by"
1949             (cons :tag "Specific tag" (const :value :tag) (string))
1950             (cons :tag "TODO keyword" (const :value :todo) (string))
1951             (cons :tag "Regular expression" (const :value :regexp) (regexp))
1952             (cons :tag "Level number" (const :value :level) (integer))
1953             (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
1954
1955 (defcustom org-refile-target-verify-function nil
1956   "Function to verify if the headline at point should be a refile target.
1957 The function will be called without arguments, with point at the
1958 beginning of the headline.  It should return t and leave point
1959 where it is if the headline is a valid target for refiling.
1960
1961 If the target should not be selected, the function must return nil.
1962 In addition to this, it may move point to a place from where the search
1963 should be continued.  For example, the function may decide that the entire
1964 subtree of the current entry should be excluded and move point to the end
1965 of the subtree."
1966   :group 'org-refile
1967   :type 'function)
1968
1969 (defcustom org-refile-use-cache nil
1970   "Non-nil means cache refile targets to speed up the process.
1971 The cache for a particular file will be updated automatically when
1972 the buffer has been killed, or when any of the marker used for flagging
1973 refile targets no longer points at a live buffer.
1974 If you have added new entries to a buffer that might themselves be targets,
1975 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1976 find that easier, `C-u C-u C-u C-c C-w'."
1977   :group 'org-refile
1978   :type 'boolean)
1979
1980 (defcustom org-refile-use-outline-path nil
1981   "Non-nil means provide refile targets as paths.
1982 So a level 3 headline will be available as level1/level2/level3.
1983
1984 When the value is `file', also include the file name (without directory)
1985 into the path.  In this case, you can also stop the completion after
1986 the file name, to get entries inserted as top level in the file.
1987
1988 When `full-file-path', include the full file path."
1989   :group 'org-refile
1990   :type '(choice
1991           (const :tag "Not" nil)
1992           (const :tag "Yes" t)
1993           (const :tag "Start with file name" file)
1994           (const :tag "Start with full file path" full-file-path)))
1995
1996 (defcustom org-outline-path-complete-in-steps t
1997   "Non-nil means complete the outline path in hierarchical steps.
1998 When Org-mode uses the refile interface to select an outline path
1999 \(see variable `org-refile-use-outline-path'), the completion of
2000 the path can be done is a single go, or if can be done in steps down
2001 the headline hierarchy.  Going in steps is probably the best if you
2002 do not use a special completion package like `ido' or `icicles'.
2003 However, when using these packages, going in one step can be very
2004 fast, while still showing the whole path to the entry."
2005   :group 'org-refile
2006   :type 'boolean)
2007
2008 (defcustom org-refile-allow-creating-parent-nodes nil
2009   "Non-nil means allow to create new nodes as refile targets.
2010 New nodes are then created by adding \"/new node name\" to the completion
2011 of an existing node.  When the value of this variable is `confirm',
2012 new node creation must be confirmed by the user (recommended)
2013 When nil, the completion must match an existing entry.
2014
2015 Note that, if the new heading is not seen by the criteria
2016 listed in `org-refile-targets', multiple instances of the same
2017 heading would be created by trying again to file under the new
2018 heading."
2019   :group 'org-refile
2020   :type '(choice
2021           (const :tag "Never" nil)
2022           (const :tag "Always" t)
2023           (const :tag "Prompt for confirmation" confirm)))
2024
2025 (defcustom org-refile-active-region-within-subtree nil
2026   "Non-nil means also refile active region within a subtree.
2027
2028 By default `org-refile' doesn't allow refiling regions if they
2029 don't contain a set of subtrees, but it might be convenient to
2030 do so sometimes: in that case, the first line of the region is
2031 converted to a headline before refiling."
2032   :group 'org-refile
2033   :type 'boolean)
2034
2035 (defgroup org-todo nil
2036   "Options concerning TODO items in Org-mode."
2037   :tag "Org TODO"
2038   :group 'org)
2039
2040 (defgroup org-progress nil
2041   "Options concerning Progress logging in Org-mode."
2042   :tag "Org Progress"
2043   :group 'org-time)
2044
2045 (defvar org-todo-interpretation-widgets
2046   '((:tag "Sequence (cycling hits every state)" sequence)
2047     (:tag "Type     (cycling directly to DONE)" type))
2048   "The available interpretation symbols for customizing `org-todo-keywords'.
2049 Interested libraries should add to this list.")
2050
2051 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2052   "List of TODO entry keyword sequences and their interpretation.
2053 \\<org-mode-map>This is a list of sequences.
2054
2055 Each sequence starts with a symbol, either `sequence' or `type',
2056 indicating if the keywords should be interpreted as a sequence of
2057 action steps, or as different types of TODO items.  The first
2058 keywords are states requiring action - these states will select a headline
2059 for inclusion into the global TODO list Org-mode produces.  If one of
2060 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2061 signify that no further action is necessary.  If \"|\" is not found,
2062 the last keyword is treated as the only DONE state of the sequence.
2063
2064 The command \\[org-todo] cycles an entry through these states, and one
2065 additional state where no keyword is present.  For details about this
2066 cycling, see the manual.
2067
2068 TODO keywords and interpretation can also be set on a per-file basis with
2069 the special #+SEQ_TODO and #+TYP_TODO lines.
2070
2071 Each keyword can optionally specify a character for fast state selection
2072 \(in combination with the variable `org-use-fast-todo-selection')
2073 and specifiers for state change logging, using the same syntax
2074 that is used in the \"#+TODO:\" lines.  For example, \"WAIT(w)\" says
2075 that the WAIT state can be selected with the \"w\" key.  \"WAIT(w!)\"
2076 indicates to record a time stamp each time this state is selected.
2077
2078 Each keyword may also specify if a timestamp or a note should be
2079 recorded when entering or leaving the state, by adding additional
2080 characters in the parenthesis after the keyword.  This looks like this:
2081 \"WAIT(w@/!)\".  \"@\" means to add a note (with time), \"!\" means to
2082 record only the time of the state change.  With X and Y being either
2083 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2084 Y when leaving the state if and only if the *target* state does not
2085 define X.  You may omit any of the fast-selection key or X or /Y,
2086 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2087
2088 For backward compatibility, this variable may also be just a list
2089 of keywords - in this case the interpretation (sequence or type) will be
2090 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2091   :group 'org-todo
2092   :group 'org-keywords
2093   :type '(choice
2094           (repeat :tag "Old syntax, just keywords"
2095                   (string :tag "Keyword"))
2096           (repeat :tag "New syntax"
2097                   (cons
2098                    (choice
2099                     :tag "Interpretation"
2100                     ;;Quick and dirty way to see
2101                     ;;`org-todo-interpretations'.  This takes the
2102                     ;;place of item arguments
2103                     :convert-widget
2104                     (lambda (widget)
2105                       (widget-put widget
2106                                   :args (mapcar
2107                                          #'(lambda (x)
2108                                              (widget-convert
2109                                               (cons 'const x)))
2110                                          org-todo-interpretation-widgets))
2111                       widget))
2112                    (repeat
2113                     (string :tag "Keyword"))))))
2114
2115 (defvar org-todo-keywords-1 nil
2116   "All TODO and DONE keywords active in a buffer.")
2117 (make-variable-buffer-local 'org-todo-keywords-1)
2118 (defvar org-todo-keywords-for-agenda nil)
2119 (defvar org-done-keywords-for-agenda nil)
2120 (defvar org-drawers-for-agenda nil)
2121 (defvar org-todo-keyword-alist-for-agenda nil)
2122 (defvar org-tag-alist-for-agenda nil)
2123 (defvar org-agenda-contributing-files nil)
2124 (defvar org-not-done-keywords nil)
2125 (make-variable-buffer-local 'org-not-done-keywords)
2126 (defvar org-done-keywords nil)
2127 (make-variable-buffer-local 'org-done-keywords)
2128 (defvar org-todo-heads nil)
2129 (make-variable-buffer-local 'org-todo-heads)
2130 (defvar org-todo-sets nil)
2131 (make-variable-buffer-local 'org-todo-sets)
2132 (defvar org-todo-log-states nil)
2133 (make-variable-buffer-local 'org-todo-log-states)
2134 (defvar org-todo-kwd-alist nil)
2135 (make-variable-buffer-local 'org-todo-kwd-alist)
2136 (defvar org-todo-key-alist nil)
2137 (make-variable-buffer-local 'org-todo-key-alist)
2138 (defvar org-todo-key-trigger nil)
2139 (make-variable-buffer-local 'org-todo-key-trigger)
2140
2141 (defcustom org-todo-interpretation 'sequence
2142   "Controls how TODO keywords are interpreted.
2143 This variable is in principle obsolete and is only used for
2144 backward compatibility, if the interpretation of todo keywords is
2145 not given already in `org-todo-keywords'.  See that variable for
2146 more information."
2147   :group 'org-todo
2148   :group 'org-keywords
2149   :type '(choice (const sequence)
2150                  (const type)))
2151
2152 (defcustom org-use-fast-todo-selection t
2153   "Non-nil means use the fast todo selection scheme with C-c C-t.
2154 This variable describes if and under what circumstances the cycling
2155 mechanism for TODO keywords will be replaced by a single-key, direct
2156 selection scheme.
2157
2158 When nil, fast selection is never used.
2159
2160 When the symbol `prefix', it will be used when `org-todo' is called with
2161 a prefix argument,  i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2162 in an agenda buffer.
2163
2164 When t, fast selection is used by default.  In this case, the prefix
2165 argument forces cycling instead.
2166
2167 In all cases, the special interface is only used if access keys have actually
2168 been assigned by the user, i.e. if keywords in the configuration are followed
2169 by a letter in parenthesis, like TODO(t)."
2170   :group 'org-todo
2171   :type '(choice
2172           (const :tag "Never" nil)
2173           (const :tag "By default" t)
2174           (const :tag "Only with C-u C-c C-t" prefix)))
2175
2176 (defcustom org-provide-todo-statistics t
2177   "Non-nil means update todo statistics after insert and toggle.
2178 ALL-HEADLINES means update todo statistics by including headlines
2179 with no TODO keyword as well, counting them as not done.
2180 A list of TODO keywords means the same, but skip keywords that are
2181 not in this list.
2182
2183 When this is set, todo statistics is updated in the parent of the
2184 current entry each time a todo state is changed."
2185   :group 'org-todo
2186   :type '(choice
2187           (const :tag "Yes, only for TODO entries" t)
2188           (const :tag "Yes, including all entries" 'all-headlines)
2189           (repeat :tag "Yes, for TODOs in this list"
2190                   (string :tag "TODO keyword"))
2191           (other :tag "No TODO statistics" nil)))
2192
2193 (defcustom org-hierarchical-todo-statistics t
2194   "Non-nil means TODO statistics covers just direct children.
2195 When nil, all entries in the subtree are considered.
2196 This has only an effect if `org-provide-todo-statistics' is set.
2197 To set this to nil for only a single subtree, use a COOKIE_DATA
2198 property and include the word \"recursive\" into the value."
2199   :group 'org-todo
2200   :type 'boolean)
2201
2202 (defcustom org-after-todo-state-change-hook nil
2203   "Hook which is run after the state of a TODO item was changed.
2204 The new state (a string with a TODO keyword, or nil) is available in the
2205 Lisp variable `state'."
2206   :group 'org-todo
2207   :type 'hook)
2208
2209 (defvar org-blocker-hook nil
2210   "Hook for functions that are allowed to block a state change.
2211
2212 Each function gets as its single argument a property list, see
2213 `org-trigger-hook' for more information about this list.
2214
2215 If any of the functions in this hook returns nil, the state change
2216 is blocked.")
2217
2218 (defvar org-trigger-hook nil
2219   "Hook for functions that are triggered by a state change.
2220
2221 Each function gets as its single argument a property list with at least
2222 the following elements:
2223
2224  (:type type-of-change :position pos-at-entry-start
2225   :from old-state :to new-state)
2226
2227 Depending on the type, more properties may be present.
2228
2229 This mechanism is currently implemented for:
2230
2231 TODO state changes
2232 ------------------
2233 :type  todo-state-change
2234 :from  previous state (keyword as a string), or nil, or a symbol
2235        'todo' or 'done', to indicate the general type of state.
2236 :to    new state, like in :from")
2237
2238 (defcustom org-enforce-todo-dependencies nil
2239   "Non-nil means undone TODO entries will block switching the parent to DONE.
2240 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2241 be blocked if any prior sibling is not yet done.
2242 Finally, if the parent is blocked because of ordered siblings of its own,
2243 the child will also be blocked.
2244 This variable needs to be set before org.el is loaded, and you need to
2245 restart Emacs after a change to make the change effective.  The only way
2246 to change is while Emacs is running is through the customize interface."
2247   :set (lambda (var val)
2248          (set var val)
2249          (if val
2250              (add-hook 'org-blocker-hook
2251                        'org-block-todo-from-children-or-siblings-or-parent)
2252            (remove-hook 'org-blocker-hook
2253                         'org-block-todo-from-children-or-siblings-or-parent)))
2254   :group 'org-todo
2255   :type 'boolean)
2256
2257 (defcustom org-enforce-todo-checkbox-dependencies nil
2258   "Non-nil means unchecked boxes will block switching the parent to DONE.
2259 When this is nil, checkboxes have no influence on switching TODO states.
2260 When non-nil, you first need to check off all check boxes before the TODO
2261 entry can be switched to DONE.
2262 This variable needs to be set before org.el is loaded, and you need to
2263 restart Emacs after a change to make the change effective.  The only way
2264 to change is while Emacs is running is through the customize interface."
2265   :set (lambda (var val)
2266          (set var val)
2267          (if val
2268              (add-hook 'org-blocker-hook
2269                        'org-block-todo-from-checkboxes)
2270            (remove-hook 'org-blocker-hook
2271                         'org-block-todo-from-checkboxes)))
2272   :group 'org-todo
2273   :type 'boolean)
2274
2275 (defcustom org-treat-insert-todo-heading-as-state-change nil
2276   "Non-nil means inserting a TODO heading is treated as state change.
2277 So when the command \\[org-insert-todo-heading] is used, state change
2278 logging will apply if appropriate.  When nil, the new TODO item will
2279 be inserted directly, and no logging will take place."
2280   :group 'org-todo
2281   :type 'boolean)
2282
2283 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2284   "Non-nil means switching TODO states with S-cursor counts as state change.
2285 This is the default behavior.  However, setting this to nil allows a
2286 convenient way to select a TODO state and bypass any logging associated
2287 with that."
2288   :group 'org-todo
2289   :type 'boolean)
2290
2291 (defcustom org-todo-state-tags-triggers nil
2292   "Tag changes that should be triggered by TODO state changes.
2293 This is a list.  Each entry is
2294
2295   (state-change (tag . flag) .......)
2296
2297 State-change can be a string with a state, and empty string to indicate the
2298 state that has no TODO keyword, or it can be one of the symbols `todo'
2299 or `done', meaning any not-done or done state, respectively."
2300   :group 'org-todo
2301   :group 'org-tags
2302   :type '(repeat
2303           (cons (choice :tag "When changing to"
2304                  (const :tag "Not-done state" todo)
2305                  (const :tag "Done state" done)
2306                  (string :tag "State"))
2307                 (repeat
2308                  (cons :tag "Tag action"
2309                        (string :tag "Tag")
2310                        (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2311
2312 (defcustom org-log-done nil
2313   "Information to record when a task moves to the DONE state.
2314
2315 Possible values are:
2316
2317 nil     Don't add anything, just change the keyword
2318 time    Add a time stamp to the task
2319 note    Prompt for a note and add it with template `org-log-note-headings'
2320
2321 This option can also be set with on a per-file-basis with
2322
2323    #+STARTUP: nologdone
2324    #+STARTUP: logdone
2325    #+STARTUP: lognotedone
2326
2327 You can have local logging settings for a subtree by setting the LOGGING
2328 property to one or more of these keywords."
2329   :group 'org-todo
2330   :group 'org-progress
2331   :type '(choice
2332           (const :tag "No logging" nil)
2333           (const :tag "Record CLOSED timestamp" time)
2334           (const :tag "Record CLOSED timestamp with note." note)))
2335
2336 ;; Normalize old uses of org-log-done.
2337 (cond
2338  ((eq org-log-done t) (setq org-log-done 'time))
2339  ((and (listp org-log-done) (memq 'done org-log-done))
2340   (setq org-log-done 'note)))
2341
2342 (defcustom org-log-reschedule nil
2343   "Information to record when the scheduling date of a tasks is modified.
2344
2345 Possible values are:
2346
2347 nil     Don't add anything, just change the date
2348 time    Add a time stamp to the task
2349 note    Prompt for a note and add it with template `org-log-note-headings'
2350
2351 This option can also be set with on a per-file-basis with
2352
2353    #+STARTUP: nologreschedule
2354    #+STARTUP: logreschedule
2355    #+STARTUP: lognotereschedule"
2356   :group 'org-todo
2357   :group 'org-progress
2358   :type '(choice
2359           (const :tag "No logging" nil)
2360           (const :tag "Record timestamp" time)
2361           (const :tag "Record timestamp with note." note)))
2362
2363 (defcustom org-log-redeadline nil
2364   "Information to record when the deadline date of a tasks is modified.
2365
2366 Possible values are:
2367
2368 nil     Don't add anything, just change the date
2369 time    Add a time stamp to the task
2370 note    Prompt for a note and add it with template `org-log-note-headings'
2371
2372 This option can also be set with on a per-file-basis with
2373
2374    #+STARTUP: nologredeadline
2375    #+STARTUP: logredeadline
2376    #+STARTUP: lognoteredeadline
2377
2378 You can have local logging settings for a subtree by setting the LOGGING
2379 property to one or more of these keywords."
2380   :group 'org-todo
2381   :group 'org-progress
2382   :type '(choice
2383           (const :tag "No logging" nil)
2384           (const :tag "Record timestamp" time)
2385           (const :tag "Record timestamp with note." note)))
2386
2387 (defcustom org-log-note-clock-out nil
2388   "Non-nil means record a note when clocking out of an item.
2389 This can also be configured on a per-file basis by adding one of
2390 the following lines anywhere in the buffer:
2391
2392    #+STARTUP: lognoteclock-out
2393    #+STARTUP: nolognoteclock-out"
2394   :group 'org-todo
2395   :group 'org-progress
2396   :type 'boolean)
2397
2398 (defcustom org-log-done-with-time t
2399   "Non-nil means the CLOSED time stamp will contain date and time.
2400 When nil, only the date will be recorded."
2401   :group 'org-progress
2402   :type 'boolean)
2403
2404 (defcustom org-log-note-headings
2405   '((done .  "CLOSING NOTE %t")
2406     (state . "State %-12s from %-12S %t")
2407     (note .  "Note taken on %t")
2408     (reschedule .  "Rescheduled from %S on %t")
2409     (delschedule .  "Not scheduled, was %S on %t")
2410     (redeadline .  "New deadline from %S on %t")
2411     (deldeadline .  "Removed deadline, was %S on %t")
2412     (refile . "Refiled on %t")
2413     (clock-out . ""))
2414   "Headings for notes added to entries.
2415 The value is an alist, with the car being a symbol indicating the note
2416 context, and the cdr is the heading to be used.  The heading may also be the
2417 empty string.
2418 %t in the heading will be replaced by a time stamp.
2419 %T will be an active time stamp instead the default inactive one
2420 %d will be replaced by a short-format time stamp.
2421 %D will be replaced by an active short-format time stamp.
2422 %s will be replaced by the new TODO state, in double quotes.
2423 %S will be replaced by the old TODO state, in double quotes.
2424 %u will be replaced by the user name.
2425 %U will be replaced by the full user name.
2426
2427 In fact, it is not a good idea to change the `state' entry, because
2428 agenda log mode depends on the format of these entries."
2429   :group  'org-todo
2430   :group  'org-progress
2431   :type '(list :greedy t
2432           (cons (const :tag "Heading when closing an item" done) string)
2433           (cons (const :tag
2434                        "Heading when changing todo state (todo sequence only)"
2435                        state) string)
2436           (cons (const :tag "Heading when just taking a note" note) string)
2437           (cons (const :tag "Heading when clocking out" clock-out) string)
2438           (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2439           (cons (const :tag "Heading when rescheduling" reschedule) string)
2440           (cons (const :tag "Heading when changing deadline"  redeadline) string)
2441           (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2442           (cons (const :tag "Heading when refiling" refile) string)))
2443
2444 (unless (assq 'note org-log-note-headings)
2445   (push '(note . "%t") org-log-note-headings))
2446
2447 (defcustom org-log-into-drawer nil
2448   "Non-nil means insert state change notes and time stamps into a drawer.
2449 When nil, state changes notes will be inserted after the headline and
2450 any scheduling and clock lines, but not inside a drawer.
2451
2452 The value of this variable should be the name of the drawer to use.
2453 LOGBOOK is proposed as the default drawer for this purpose, you can
2454 also set this to a string to define the drawer of your choice.
2455
2456 A value of t is also allowed, representing \"LOGBOOK\".
2457
2458 If this variable is set, `org-log-state-notes-insert-after-drawers'
2459 will be ignored.
2460
2461 You can set the property LOG_INTO_DRAWER to overrule this setting for
2462 a subtree."
2463   :group 'org-todo
2464   :group 'org-progress
2465   :type '(choice
2466           (const :tag "Not into a drawer" nil)
2467           (const :tag "LOGBOOK" t)
2468           (string :tag "Other")))
2469
2470 (if (fboundp 'defvaralias)
2471     (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
2472
2473 (defun org-log-into-drawer ()
2474   "Return the value of `org-log-into-drawer', but let properties overrule.
2475 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2476 used instead of the default value."
2477   (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
2478     (cond
2479      ((or (not p) (equal p "nil")) org-log-into-drawer)
2480      ((equal p "t") "LOGBOOK")
2481      (t p))))
2482
2483 (defcustom org-log-state-notes-insert-after-drawers nil
2484   "Non-nil means insert state change notes after any drawers in entry.
2485 Only the drawers that *immediately* follow the headline and the
2486 deadline/scheduled line are skipped.
2487 When nil, insert notes right after the heading and perhaps the line
2488 with deadline/scheduling if present.
2489
2490 This variable will have no effect if `org-log-into-drawer' is
2491 set."
2492   :group 'org-todo
2493   :group 'org-progress
2494   :type 'boolean)
2495
2496 (defcustom org-log-states-order-reversed t
2497   "Non-nil means the latest state note will be directly after heading.
2498 When nil, the state change notes will be ordered according to time."
2499   :group 'org-todo
2500   :group 'org-progress
2501   :type 'boolean)
2502
2503 (defcustom org-todo-repeat-to-state nil
2504   "The TODO state to which a repeater should return the repeating task.
2505 By default this is the first task in a TODO sequence, or the previous state
2506 in a TODO_TYP set.  But you can specify another task here.
2507 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2508   :group 'org-todo
2509   :type '(choice (const :tag "Head of sequence" nil)
2510                  (string :tag "Specific state")))
2511
2512 (defcustom org-log-repeat 'time
2513   "Non-nil means record moving through the DONE state when triggering repeat.
2514 An auto-repeating task is immediately switched back to TODO when
2515 marked DONE.  If you are not logging state changes (by adding \"@\"
2516 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2517 record a closing note, there will be no record of the task moving
2518 through DONE.  This variable forces taking a note anyway.
2519
2520 nil     Don't force a record
2521 time    Record a time stamp
2522 note    Record a note
2523
2524 This option can also be set with on a per-file-basis with
2525
2526    #+STARTUP: logrepeat
2527    #+STARTUP: lognoterepeat
2528    #+STARTUP: nologrepeat
2529
2530 You can have local logging settings for a subtree by setting the LOGGING
2531 property to one or more of these keywords."
2532   :group 'org-todo
2533   :group 'org-progress
2534   :type '(choice
2535           (const :tag "Don't force a record" nil)
2536           (const :tag "Force recording the DONE state" time)
2537           (const :tag "Force recording a note with the DONE state" note)))
2538
2539
2540 (defgroup org-priorities nil
2541   "Priorities in Org-mode."
2542   :tag "Org Priorities"
2543   :group 'org-todo)
2544
2545 (defcustom org-enable-priority-commands t
2546   "Non-nil means priority commands are active.
2547 When nil, these commands will be disabled, so that you never accidentally
2548 set a priority."
2549   :group 'org-priorities
2550   :type 'boolean)
2551
2552 (defcustom org-highest-priority ?A
2553   "The highest priority of TODO items.  A character like ?A, ?B etc.
2554 Must have a smaller ASCII number than `org-lowest-priority'."
2555   :group 'org-priorities
2556   :type 'character)
2557
2558 (defcustom org-lowest-priority ?C
2559   "The lowest priority of TODO items.  A character like ?A, ?B etc.
2560 Must have a larger ASCII number than `org-highest-priority'."
2561   :group 'org-priorities
2562   :type 'character)
2563
2564 (defcustom org-default-priority ?B
2565   "The default priority of TODO items.
2566 This is the priority an item gets if no explicit priority is given.
2567 When starting to cycle on an empty priority the first step in the cycle
2568 depends on `org-priority-start-cycle-with-default'.  The resulting first
2569 step priority must not exceed the range from `org-highest-priority' to
2570 `org-lowest-priority' which means that `org-default-priority' has to be
2571 in this range exclusive or inclusive the range boundaries.  Else the
2572 first step refuses to set the default and the second will fall back
2573 to (depending on the command used) the highest or lowest priority."
2574   :group 'org-priorities
2575   :type 'character)
2576
2577 (defcustom org-priority-start-cycle-with-default t
2578   "Non-nil means start with default priority when starting to cycle.
2579 When this is nil, the first step in the cycle will be (depending on the
2580 command used) one higher or lower than the default priority.
2581 See also `org-default-priority'."
2582   :group 'org-priorities
2583   :type 'boolean)
2584
2585 (defcustom org-get-priority-function nil
2586   "Function to extract the priority from a string.
2587 The string is normally the headline.  If this is nil Org computes the
2588 priority from the priority cookie like [#A] in the headline.  It returns
2589 an integer, increasing by 1000 for each priority level.
2590 The user can set a different function here, which should take a string
2591 as an argument and return the numeric priority."
2592   :group 'org-priorities
2593   :type 'function)
2594
2595 (defgroup org-time nil
2596   "Options concerning time stamps and deadlines in Org-mode."
2597   :tag "Org Time"
2598   :group 'org)
2599
2600 (defcustom org-insert-labeled-timestamps-at-point nil
2601   "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2602 When nil, these labeled time stamps are forces into the second line of an
2603 entry, just after the headline.  When scheduling from the global TODO list,
2604 the time stamp will always be forced into the second line."
2605   :group 'org-time
2606   :type 'boolean)
2607
2608 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
2609   "Formats for `format-time-string' which are used for time stamps.
2610 It is not recommended to change this constant.")
2611
2612 (defcustom org-time-stamp-rounding-minutes '(0 5)
2613   "Number of minutes to round time stamps to.
2614 These are two values, the first applies when first creating a time stamp.
2615 The second applies when changing it with the commands `S-up' and `S-down'.
2616 When changing the time stamp, this means that it will change in steps
2617 of N minutes, as given by the second value.
2618
2619 When a setting is 0 or 1, insert the time unmodified.  Useful rounding
2620 numbers should be factors of 60, so for example 5, 10, 15.
2621
2622 When this is larger than 1, you can still force an exact time stamp by using
2623 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2624 and by using a prefix arg to `S-up/down' to specify the exact number
2625 of minutes to shift."
2626   :group 'org-time
2627   :get #'(lambda (var) ; Make sure both elements are there
2628           (if (integerp (default-value var))
2629               (list (default-value var) 5)
2630             (default-value var)))
2631   :type '(list
2632           (integer :tag "when inserting times")
2633           (integer :tag "when modifying times")))
2634
2635 ;; Normalize old customizations of this variable.
2636 (when (integerp org-time-stamp-rounding-minutes)
2637   (setq org-time-stamp-rounding-minutes
2638         (list org-time-stamp-rounding-minutes
2639               org-time-stamp-rounding-minutes)))
2640
2641 (defcustom org-display-custom-times nil
2642   "Non-nil means overlay custom formats over all time stamps.
2643 The formats are defined through the variable `org-time-stamp-custom-formats'.
2644 To turn this on on a per-file basis, insert anywhere in the file:
2645    #+STARTUP: customtime"
2646   :group 'org-time
2647   :set 'set-default
2648   :type 'sexp)
2649 (make-variable-buffer-local 'org-display-custom-times)
2650
2651 (defcustom org-time-stamp-custom-formats
2652   '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
2653   "Custom formats for time stamps.  See `format-time-string' for the syntax.
2654 These are overlayed over the default ISO format if the variable
2655 `org-display-custom-times' is set.  Time like %H:%M should be at the
2656 end of the second format.  The custom formats are also honored by export
2657 commands, if custom time display is turned on at the time of export."
2658   :group 'org-time
2659   :type 'sexp)
2660
2661 (defun org-time-stamp-format (&optional long inactive)
2662   "Get the right format for a time string."
2663   (let ((f (if long (cdr org-time-stamp-formats)
2664              (car org-time-stamp-formats))))
2665     (if inactive
2666         (concat "[" (substring f 1 -1) "]")
2667       f)))
2668
2669 (defcustom org-time-clocksum-format "%d:%02d"
2670   "The format string used when creating CLOCKSUM lines.
2671 This is also used when org-mode generates a time duration."
2672   :group 'org-time
2673   :type 'string)
2674
2675 (defcustom org-time-clocksum-use-fractional nil
2676   "If non-nil, \\[org-clock-display] uses fractional times.
2677 org-mode generates a time duration."
2678   :group 'org-time
2679   :type 'boolean)
2680
2681 (defcustom org-time-clocksum-fractional-format "%.2f"
2682   "The format string used when creating CLOCKSUM lines, or when
2683 org-mode generates a time duration."
2684   :group 'org-time
2685   :type 'string)
2686
2687 (defcustom org-deadline-warning-days 14
2688   "No. of days before expiration during which a deadline becomes active.
2689 This variable governs the display in sparse trees and in the agenda.
2690 When 0 or negative, it means use this number (the absolute value of it)
2691 even if a deadline has a different individual lead time specified.
2692
2693 Custom commands can set this variable in the options section."
2694   :group 'org-time
2695   :group 'org-agenda-daily/weekly
2696   :type 'integer)
2697
2698 (defcustom org-read-date-prefer-future t
2699   "Non-nil means assume future for incomplete date input from user.
2700 This affects the following situations:
2701 1. The user gives a month but not a year.
2702    For example, if it is April and you enter \"feb 2\", this will be read
2703    as Feb 2, *next* year.  \"May 5\", however, will be this year.
2704 2. The user gives a day, but no month.
2705    For example, if today is the 15th, and you enter \"3\", Org-mode will
2706    read this as the third of *next* month.  However, if you enter \"17\",
2707    it will be considered as *this* month.
2708
2709 If you set this variable to the symbol `time', then also the following
2710 will work:
2711
2712 3. If the user gives a time, but no day.  If the time is before now,
2713    to will be interpreted as tomorrow.
2714
2715 Currently none of this works for ISO week specifications.
2716
2717 When this option is nil, the current day, month and year will always be
2718 used as defaults.
2719
2720 See also `org-agenda-jump-prefer-future'."
2721   :group 'org-time
2722   :type '(choice
2723           (const :tag "Never" nil)
2724           (const :tag "Check month and day" t)
2725           (const :tag "Check month, day, and time" time)))
2726
2727 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
2728   "Should the agenda jump command prefer the future for incomplete dates?
2729 The default is to do the same as configured in `org-read-date-prefer-future'.
2730 But you can also set a deviating value here.
2731 This may t or nil, or the symbol `org-read-date-prefer-future'."
2732   :group 'org-agenda
2733   :group 'org-time
2734   :type '(choice
2735           (const :tag "Use org-read-date-prefer-future"
2736                  org-read-date-prefer-future)
2737           (const :tag "Never" nil)
2738           (const :tag "Always" t)))
2739
2740 (defcustom org-read-date-force-compatible-dates t
2741   "Should date/time prompt force dates that are guaranteed to work in Emacs?
2742
2743 Depending on the system Emacs is running on, certain dates cannot
2744 be represented with the type used internally to represent time.
2745 Dates between 1970-1-1 and 2038-1-1 can always be represented
2746 correctly.  Some systems allow for earlier dates, some for later,
2747 some for both.  One way to find out it to insert any date into an
2748 Org buffer, putting the cursor on the year and hitting S-up and
2749 S-down to test the range.
2750
2751 When this variable is set to t, the date/time prompt will not let
2752 you specify dates outside the 1970-2037 range, so it is certain that
2753 these dates will work in whatever version of Emacs you are
2754 running, and also that you can move a file from one Emacs implementation
2755 to another.  WHenever Org is forcing the year for you, it will display
2756 a message and beep.
2757
2758 When this variable is nil, Org will check if the date is
2759 representable in the specific Emacs implementation you are using.
2760 If not, it will force a year, usually the current year, and beep
2761 to remind you.  Currently this setting is not recommended because
2762 the likelihood that you will open your Org files in an Emacs that
2763 has limited date range is not negligible.
2764
2765 A workaround for this problem is to use diary sexp dates for time
2766 stamps outside of this range."
2767   :group 'org-time
2768   :type 'boolean)
2769
2770 (defcustom org-read-date-display-live t
2771   "Non-nil means display current interpretation of date prompt live.
2772 This display will be in an overlay, in the minibuffer."
2773   :group 'org-time
2774   :type 'boolean)
2775
2776 (defcustom org-read-date-popup-calendar t
2777   "Non-nil means pop up a calendar when prompting for a date.
2778 In the calendar, the date can be selected with mouse-1.  However, the
2779 minibuffer will also be active, and you can simply enter the date as well.
2780 When nil, only the minibuffer will be available."
2781   :group 'org-time
2782   :type 'boolean)
2783 (if (fboundp 'defvaralias)
2784     (defvaralias 'org-popup-calendar-for-date-prompt
2785       'org-read-date-popup-calendar))
2786
2787 (defcustom org-read-date-minibuffer-setup-hook nil
2788   "Hook to be used to set up keys for the date/time interface.
2789 Add key definitions to `minibuffer-local-map', which will be a temporary
2790 copy."
2791   :group 'org-time
2792   :type 'hook)
2793
2794 (defcustom org-extend-today-until 0
2795   "The hour when your day really ends.  Must be an integer.
2796 This has influence for the following applications:
2797 - When switching the agenda to \"today\".  It it is still earlier than
2798   the time given here, the day recognized as TODAY is actually yesterday.
2799 - When a date is read from the user and it is still before the time given
2800   here, the current date and time will be assumed to be yesterday, 23:59.
2801   Also, timestamps inserted in remember templates follow this rule.
2802
2803 IMPORTANT:  This is a feature whose implementation is and likely will
2804 remain incomplete.  Really, it is only here because past midnight seems to
2805 be the favorite working time of John Wiegley :-)"
2806   :group 'org-time
2807   :type 'integer)
2808
2809 (defcustom org-use-effective-time nil
2810   "If non-nil, consider `org-extend-today-until' when creating timestamps.
2811 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2812 \"effective time\" of any timestamps between midnight and 8am will be
2813 23:59 of the previous day."
2814   :group 'boolean
2815   :type 'integer)
2816
2817 (defcustom org-edit-timestamp-down-means-later nil
2818   "Non-nil means S-down will increase the time in a time stamp.
2819 When nil, S-up will increase."
2820   :group 'org-time
2821   :type 'boolean)
2822
2823 (defcustom org-calendar-follow-timestamp-change t
2824   "Non-nil means make the calendar window follow timestamp changes.
2825 When a timestamp is modified and the calendar window is visible, it will be
2826 moved to the new date."
2827   :group 'org-time
2828   :type 'boolean)
2829
2830 (defgroup org-tags nil
2831   "Options concerning tags in Org-mode."
2832   :tag "Org Tags"
2833   :group 'org)
2834
2835 (defcustom org-tag-alist nil
2836   "List of tags allowed in Org-mode files.
2837 When this list is nil, Org-mode will base TAG input on what is already in the
2838 buffer.
2839 The value of this variable is an alist, the car of each entry must be a
2840 keyword as a string, the cdr may be a character that is used to select
2841 that tag through the fast-tag-selection interface.
2842 See the manual for details."
2843   :group 'org-tags
2844   :type '(repeat
2845           (choice
2846            (cons   (string    :tag "Tag name")
2847                    (character :tag "Access char"))
2848            (list :tag "Start radio group"
2849                  (const :startgroup)
2850                  (option (string :tag "Group description")))
2851            (list :tag "End radio group"
2852                  (const :endgroup)
2853                  (option (string :tag "Group description")))
2854            (const :tag "New line" (:newline)))))
2855
2856 (defcustom org-tag-persistent-alist nil
2857   "List of tags that will always appear in all Org-mode files.
2858 This is in addition to any in buffer settings or customizations
2859 of `org-tag-alist'.
2860 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2861 The value of this variable is an alist, the car of each entry must be a
2862 keyword as a string, the cdr may be a character that is used to select
2863 that tag through the fast-tag-selection interface.
2864 See the manual for details.
2865 To disable these tags on a per-file basis, insert anywhere in the file:
2866    #+STARTUP: noptag"
2867   :group 'org-tags
2868   :type '(repeat
2869           (choice
2870            (cons   (string    :tag "Tag name")
2871                    (character :tag "Access char"))
2872            (const :tag "Start radio group" (:startgroup))
2873            (const :tag "End radio group" (:endgroup))
2874            (const :tag "New line" (:newline)))))
2875
2876 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
2877   "If non-nil, always offer completion for all tags of all agenda files.
2878 Instead of customizing this variable directly, you might want to
2879 set it locally for capture buffers, because there no list of
2880 tags in that file can be created dynamically (there are none).
2881
2882   (add-hook 'org-capture-mode-hook
2883             (lambda ()
2884               (set (make-local-variable
2885                     'org-complete-tags-always-offer-all-agenda-tags)
2886                    t)))"
2887   :group 'org-tags
2888   :type 'boolean)
2889
2890 (defvar org-file-tags nil
2891   "List of tags that can be inherited by all entries in the file.
2892 The tags will be inherited if the variable `org-use-tag-inheritance'
2893 says they should be.
2894 This variable is populated from #+FILETAGS lines.")
2895
2896 (defcustom org-use-fast-tag-selection 'auto
2897   "Non-nil means use fast tag selection scheme.
2898 This is a special interface to select and deselect tags with single keys.
2899 When nil, fast selection is never used.
2900 When the symbol `auto', fast selection is used if and only if selection
2901 characters for tags have been configured, either through the variable
2902 `org-tag-alist' or through a #+TAGS line in the buffer.
2903 When t, fast selection is always used and selection keys are assigned
2904 automatically if necessary."
2905   :group 'org-tags
2906   :type '(choice
2907           (const :tag "Always" t)
2908           (const :tag "Never" nil)
2909           (const :tag "When selection characters are configured" 'auto)))
2910
2911 (defcustom org-fast-tag-selection-single-key nil
2912   "Non-nil means fast tag selection exits after first change.
2913 When nil, you have to press RET to exit it.
2914 During fast tag selection, you can toggle this flag with `C-c'.
2915 This variable can also have the value `expert'.  In this case, the window
2916 displaying the tags menu is not even shown, until you press C-c again."
2917   :group 'org-tags
2918   :type '(choice
2919           (const :tag "No" nil)
2920           (const :tag "Yes" t)
2921           (const :tag "Expert" expert)))
2922
2923 (defvar org-fast-tag-selection-include-todo nil
2924   "Non-nil means fast tags selection interface will also offer TODO states.
2925 This is an undocumented feature, you should not rely on it.")
2926
2927 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
2928   "The column to which tags should be indented in a headline.
2929 If this number is positive, it specifies the column.  If it is negative,
2930 it means that the tags should be flushright to that column.  For example,
2931 -80 works well for a normal 80 character screen.
2932 When 0, place tags directly after headline text, with only one space in
2933 between."
2934   :group 'org-tags
2935   :type 'integer)
2936
2937 (defcustom org-auto-align-tags t
2938   "Non-nil keeps tags aligned when modifying headlines.
2939 Some operations (i.e. demoting) change the length of a headline and
2940 therefore shift the tags around.  With this option turned on, after
2941 each such operation the tags are again aligned to `org-tags-column'."
2942   :group 'org-tags
2943   :type 'boolean)
2944
2945 (defcustom org-use-tag-inheritance t
2946   "Non-nil means tags in levels apply also for sublevels.
2947 When nil, only the tags directly given in a specific line apply there.
2948 This may also be a list of tags that should be inherited, or a regexp that
2949 matches tags that should be inherited.  Additional control is possible
2950 with the variable  `org-tags-exclude-from-inheritance' which gives an
2951 explicit list of tags to be excluded from inheritance., even if the value of
2952 `org-use-tag-inheritance' would select it for inheritance.
2953
2954 If this option is t, a match early-on in a tree can lead to a large
2955 number of matches in the subtree when constructing the agenda or creating
2956 a sparse tree.  If you only want to see the first match in a tree during
2957 a search, check out the variable `org-tags-match-list-sublevels'."
2958   :group 'org-tags
2959   :type '(choice
2960           (const :tag "Not" nil)
2961           (const :tag "Always" t)
2962           (repeat :tag "Specific tags" (string :tag "Tag"))
2963           (regexp :tag "Tags matched by regexp")))
2964
2965 (defcustom org-tags-exclude-from-inheritance nil
2966   "List of tags that should never be inherited.
2967 This is a way to exclude a few tags from inheritance.  For way to do
2968 the opposite, to actively allow inheritance for selected tags,
2969 see the variable `org-use-tag-inheritance'."
2970   :group 'org-tags
2971   :type '(repeat (string :tag "Tag")))
2972
2973 (defun org-tag-inherit-p (tag)
2974   "Check if TAG is one that should be inherited."
2975   (cond
2976    ((member tag org-tags-exclude-from-inheritance) nil)
2977    ((eq org-use-tag-inheritance t) t)
2978    ((not org-use-tag-inheritance) nil)
2979    ((stringp org-use-tag-inheritance)
2980     (string-match org-use-tag-inheritance tag))
2981    ((listp org-use-tag-inheritance)
2982     (member tag org-use-tag-inheritance))
2983    (t (error "Invalid setting of `org-use-tag-inheritance'"))))
2984
2985 (defcustom org-tags-match-list-sublevels t
2986   "Non-nil means list also sublevels of headlines matching a search.
2987 This variable applies to tags/property searches, and also to stuck
2988 projects because this search is based on a tags match as well.
2989
2990 When set to the symbol `indented', sublevels are indented with
2991 leading dots.
2992
2993 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2994 the sublevels of a headline matching a tag search often also match
2995 the same search.  Listing all of them can create very long lists.
2996 Setting this variable to nil causes subtrees of a match to be skipped.
2997
2998 This variable is semi-obsolete and probably should always be true.  It
2999 is better to limit inheritance to certain tags using the variables
3000 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3001   :group 'org-tags
3002   :type '(choice
3003           (const :tag "No, don't list them" nil)
3004           (const :tag "Yes, do list them" t)
3005           (const :tag "List them, indented with leading dots" indented)))
3006
3007 (defcustom org-tags-sort-function nil
3008   "When set, tags are sorted using this function as a comparator."
3009   :group 'org-tags
3010   :type '(choice
3011           (const :tag "No sorting" nil)
3012           (const :tag "Alphabetical" string<)
3013           (const :tag "Reverse alphabetical" string>)
3014           (function :tag "Custom function" nil)))
3015
3016 (defvar org-tags-history nil
3017   "History of minibuffer reads for tags.")
3018 (defvar org-last-tags-completion-table nil
3019   "The last used completion table for tags.")
3020 (defvar org-after-tags-change-hook nil
3021   "Hook that is run after the tags in a line have changed.")
3022
3023 (defgroup org-properties nil
3024   "Options concerning properties in Org-mode."
3025   :tag "Org Properties"
3026   :group 'org)
3027
3028 (defcustom org-property-format "%-10s %s"
3029   "How property key/value pairs should be formatted by `indent-line'.
3030 When `indent-line' hits a property definition, it will format the line
3031 according to this format, mainly to make sure that the values are
3032 lined-up with respect to each other."
3033   :group 'org-properties
3034   :type 'string)
3035
3036 (defcustom org-properties-postprocess-alist nil
3037   "Alist of properties and functions to adjust inserted values.
3038 Elements of this alist must be of the form
3039
3040   ([string] [function])
3041
3042 where [string] must be a property name and [function] must be a
3043 lambda expression: this lambda expression must take one argument,
3044 the value to adjust, and return the new value as a string.
3045
3046 For example, this element will allow the property \"Remaining\"
3047 to be updated wrt the relation between the \"Effort\" property
3048 and the clock summary:
3049
3050  ((\"Remaining\" (lambda(value)
3051                    (let ((clocksum (org-clock-sum-current-item))
3052                          (effort (org-duration-string-to-minutes
3053                                    (org-entry-get (point) \"Effort\"))))
3054                      (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3055   :group 'org-properties
3056   :type 'alist)
3057
3058 (defcustom org-use-property-inheritance nil
3059   "Non-nil means properties apply also for sublevels.
3060
3061 This setting is chiefly used during property searches.  Turning it on can
3062 cause significant overhead when doing a search, which is why it is not
3063 on by default.
3064
3065 When nil, only the properties directly given in the current entry count.
3066 When t, every property is inherited.  The value may also be a list of
3067 properties that should have inheritance, or a regular expression matching
3068 properties that should be inherited.
3069
3070 However, note that some special properties use inheritance under special
3071 circumstances (not in searches).  Examples are CATEGORY, ARCHIVE, COLUMNS,
3072 and the properties ending in \"_ALL\" when they are used as descriptor
3073 for valid values of a property.
3074
3075 Note for programmers:
3076 When querying an entry with `org-entry-get',  you can control if inheritance
3077 should be used.  By default, `org-entry-get' looks only at the local
3078 properties.  You can request inheritance by setting the inherit argument
3079 to t (to force inheritance) or to `selective' (to respect the setting
3080 in this variable)."
3081   :group 'org-properties
3082   :type '(choice
3083           (const :tag "Not" nil)
3084           (const :tag "Always" t)
3085           (repeat :tag "Specific properties" (string :tag "Property"))
3086           (regexp :tag "Properties matched by regexp")))
3087
3088 (defun org-property-inherit-p (property)
3089   "Check if PROPERTY is one that should be inherited."
3090   (cond
3091    ((eq org-use-property-inheritance t) t)
3092    ((not org-use-property-inheritance) nil)
3093    ((stringp org-use-property-inheritance)
3094     (string-match org-use-property-inheritance property))
3095    ((listp org-use-property-inheritance)
3096     (member property org-use-property-inheritance))
3097    (t (error "Invalid setting of `org-use-property-inheritance'"))))
3098
3099 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3100   "The default column format, if no other format has been defined.
3101 This variable can be set on the per-file basis by inserting a line
3102
3103 #+COLUMNS: %25ITEM ....."
3104   :group 'org-properties
3105   :type 'string)
3106
3107 (defcustom org-columns-ellipses ".."
3108   "The ellipses to be used when a field in column view is truncated.
3109 When this is the empty string, as many characters as possible are shown,
3110 but then there will be no visual indication that the field has been truncated.
3111 When this is a string of length N, the last N characters of a truncated
3112 field are replaced by this string.  If the column is narrower than the
3113 ellipses string, only part of the ellipses string will be shown."
3114   :group 'org-properties
3115   :type 'string)
3116
3117 (defcustom org-columns-modify-value-for-display-function nil
3118   "Function that modifies values for display in column view.
3119 For example, it can be used to cut out a certain part from a time stamp.
3120 The function must take 2 arguments:
3121
3122 column-title    The title of the column (*not* the property name)
3123 value           The value that should be modified.
3124
3125 The function should return the value that should be displayed,
3126 or nil if the normal value should be used."
3127   :group 'org-properties
3128   :type 'function)
3129
3130 (defcustom org-effort-property "Effort"
3131   "The property that is being used to keep track of effort estimates.
3132 Effort estimates given in this property need to have the format H:MM."
3133   :group 'org-properties
3134   :group 'org-progress
3135   :type '(string :tag "Property"))
3136
3137 (defconst org-global-properties-fixed
3138   '(("VISIBILITY_ALL" . "folded children content all")
3139     ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3140   "List of property/value pairs that can be inherited by any entry.
3141
3142 These are fixed values, for the preset properties.  The user variable
3143 that can be used to add to this list is `org-global-properties'.
3144
3145 The entries in this list are cons cells where the car is a property
3146 name and cdr is a string with the value.  If the value represents
3147 multiple items like an \"_ALL\" property, separate the items by
3148 spaces.")
3149
3150 (defcustom org-global-properties nil
3151   "List of property/value pairs that can be inherited by any entry.
3152
3153 This list will be combined with the constant `org-global-properties-fixed'.
3154
3155 The entries in this list are cons cells where the car is a property
3156 name and cdr is a string with the value.
3157
3158 You can set buffer-local values for the same purpose in the variable
3159 `org-file-properties' this by adding lines like
3160
3161 #+PROPERTY: NAME VALUE"
3162   :group 'org-properties
3163   :type '(repeat
3164           (cons (string :tag "Property")
3165                 (string :tag "Value"))))
3166
3167 (defvar org-file-properties nil
3168   "List of property/value pairs that can be inherited by any entry.
3169 Valid for the current buffer.
3170 This variable is populated from #+PROPERTY lines.")
3171 (make-variable-buffer-local 'org-file-properties)
3172
3173 (defgroup org-agenda nil
3174   "Options concerning agenda views in Org-mode."
3175   :tag "Org Agenda"
3176   :group 'org)
3177
3178 (defvar org-category nil
3179   "Variable used by org files to set a category for agenda display.
3180 Such files should use a file variable to set it, for example
3181
3182 #   -*- mode: org; org-category: \"ELisp\"
3183
3184 or contain a special line
3185
3186 #+CATEGORY: ELisp
3187
3188 If the file does not specify a category, then file's base name
3189 is used instead.")
3190 (make-variable-buffer-local 'org-category)
3191 (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
3192
3193 (defcustom org-agenda-files nil
3194   "The files to be used for agenda display.
3195 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3196 \\[org-remove-file].  You can also use customize to edit the list.
3197
3198 If an entry is a directory, all files in that directory that are matched by
3199 `org-agenda-file-regexp' will be part of the file list.
3200
3201 If the value of the variable is not a list but a single file name, then
3202 the list of agenda files is actually stored and maintained in that file, one
3203 agenda file per line.  In this file paths can be given relative to
3204 `org-directory'.  Tilde expansion and environment variable substitution
3205 are also made."
3206   :group 'org-agenda
3207   :type '(choice
3208           (repeat :tag "List of files and directories" file)
3209           (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3210
3211 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3212   "Regular expression to match files for `org-agenda-files'.
3213 If any element in the list in that variable contains a directory instead
3214 of a normal file, all files in that directory that are matched by this
3215 regular expression will be included."
3216   :group 'org-agenda
3217   :type 'regexp)
3218
3219 (defcustom org-agenda-text-search-extra-files nil
3220   "List of extra files to be searched by text search commands.
3221 These files will be search in addition to the agenda files by the
3222 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3223 Note that these files will only be searched for text search commands,
3224 not for the other agenda views like todo lists, tag searches or the weekly
3225 agenda.  This variable is intended to list notes and possibly archive files
3226 that should also be searched by these two commands.
3227 In fact, if the first element in the list is the symbol `agenda-archives',
3228 than all archive files of all agenda files will be added to the search
3229 scope."
3230   :group 'org-agenda
3231   :type '(set :greedy t
3232            (const :tag "Agenda Archives" agenda-archives)
3233            (repeat :inline t (file))))
3234
3235 (if (fboundp 'defvaralias)
3236     (defvaralias 'org-agenda-multi-occur-extra-files
3237       'org-agenda-text-search-extra-files))
3238
3239 (defcustom org-agenda-skip-unavailable-files nil
3240   "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3241 A nil value means to remove them, after a query, from the list."
3242   :group 'org-agenda
3243   :type 'boolean)
3244
3245 (defcustom org-calendar-to-agenda-key [?c]
3246   "The key to be installed in `calendar-mode-map' for switching to the agenda.
3247 The command `org-calendar-goto-agenda' will be bound to this key.  The
3248 default is the character `c' because then `c' can be used to switch back and
3249 forth between agenda and calendar."
3250   :group 'org-agenda
3251   :type 'sexp)
3252
3253 (defcustom org-calendar-agenda-action-key [?k]
3254   "The key to be installed in `calendar-mode-map' for agenda-action.
3255 The command `org-agenda-action' will be bound to this key.  The
3256 default is the character `k' because we use the same key in the agenda."
3257   :group 'org-agenda
3258   :type 'sexp)
3259
3260 (defcustom org-calendar-insert-diary-entry-key [?i]
3261   "The key to be installed in `calendar-mode-map' for adding diary entries.
3262 This option is irrelevant until `org-agenda-diary-file' has been configured
3263 to point to an Org-mode file.  When that is the case, the command
3264 `org-agenda-diary-entry' will be bound to the key given here, by default
3265 `i'.  In the calendar, `i' normally adds entries to `diary-file'.  So
3266 if you want to continue doing this, you need to change this to a different
3267 key."
3268   :group 'org-agenda
3269   :type 'sexp)
3270
3271 (defcustom org-agenda-diary-file 'diary-file
3272   "File to which to add new entries with the `i' key in agenda and calendar.
3273 When this is the symbol `diary-file', the functionality in the Emacs
3274 calendar will be used to add entries to the `diary-file'.  But when this
3275 points to a file, `org-agenda-diary-entry' will be used instead."
3276   :group 'org-agenda
3277   :type '(choice
3278           (const :tag "The standard Emacs diary file" diary-file)
3279           (file :tag "Special Org file diary entries")))
3280
3281 (eval-after-load "calendar"
3282   '(progn
3283      (org-defkey calendar-mode-map org-calendar-to-agenda-key
3284                  'org-calendar-goto-agenda)
3285      (org-defkey calendar-mode-map org-calendar-agenda-action-key
3286                  'org-agenda-action)
3287      (add-hook 'calendar-mode-hook
3288                (lambda ()
3289                  (unless (eq org-agenda-diary-file 'diary-file)
3290                    (define-key calendar-mode-map
3291                      org-calendar-insert-diary-entry-key
3292                      'org-agenda-diary-entry))))))
3293
3294 (defgroup org-latex nil
3295   "Options for embedding LaTeX code into Org-mode."
3296   :tag "Org LaTeX"
3297   :group 'org)
3298
3299 (defcustom org-format-latex-options
3300   '(:foreground default :background default :scale 1.0
3301     :html-foreground "Black" :html-background "Transparent"
3302     :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3303   "Options for creating images from LaTeX fragments.
3304 This is a property list with the following properties:
3305 :foreground  the foreground color for images embedded in Emacs, e.g. \"Black\".
3306              `default' means use the foreground of the default face.
3307 :background  the background color, or \"Transparent\".
3308              `default' means use the background of the default face.
3309 :scale       a scaling factor for the size of the images, to get more pixels
3310 :html-foreground, :html-background, :html-scale
3311              the same numbers for HTML export.
3312 :matchers    a list indicating which matchers should be used to
3313              find LaTeX fragments.  Valid members of this list are:
3314              \"begin\"  find environments
3315              \"$1\"     find single characters surrounded by $.$
3316              \"$\"      find math expressions surrounded by $...$
3317              \"$$\"     find math expressions surrounded by $$....$$
3318              \"\\(\"     find math expressions surrounded by \\(...\\)
3319              \"\\ [\"    find math expressions surrounded by \\ [...\\]"
3320   :group 'org-latex
3321   :type 'plist)
3322
3323 (defcustom org-format-latex-signal-error t
3324   "Non-nil means signal an error when image creation of LaTeX snippets fails.
3325 When nil, just push out a message."
3326   :group 'org-latex
3327   :type 'boolean)
3328 (defcustom org-latex-to-mathml-jar-file nil
3329   "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3330 Use this to specify additional executable file say a jar file.
3331
3332 When using MathToWeb as the converter, specify the full-path to
3333 your mathtoweb.jar file."
3334   :group 'org-latex
3335   :type '(choice
3336           (const :tag "None" nil)
3337           (file :tag "JAR file" :must-match t)))
3338
3339 (defcustom org-latex-to-mathml-convert-command nil
3340   "Command to convert LaTeX fragments to MathML.
3341 Replace format-specifiers in the command as noted below and use
3342 `shell-command' to convert LaTeX to MathML.
3343 %j:     Executable file in fully expanded form as specified by
3344         `org-latex-to-mathml-jar-file'.
3345 %I:     Input LaTeX file in fully expanded form
3346 %o:     Output MathML file
3347 This command is used by `org-create-math-formula'.
3348
3349 When using MathToWeb as the converter, set this to
3350 \"java -jar %j -unicode -force -df %o %I\"."
3351   :group 'org-latex
3352   :type '(choice
3353           (const :tag "None" nil)
3354           (string :tag "\nShell command")))
3355
3356 (defun org-format-latex-mathml-available-p ()
3357   "Return t if `org-latex-to-mathml-convert-command' is usable."
3358   (save-match-data
3359     (when (and (boundp 'org-latex-to-mathml-convert-command)
3360                org-latex-to-mathml-convert-command)
3361       (let ((executable (car (split-string
3362                               org-latex-to-mathml-convert-command))))
3363         (when (executable-find executable)
3364           (if (string-match
3365                "%j" org-latex-to-mathml-convert-command)
3366               (file-readable-p org-latex-to-mathml-jar-file)
3367             t))))))
3368
3369 (defcustom org-format-latex-header "\\documentclass{article}
3370 \\usepackage[usenames]{color}
3371 \\usepackage{amsmath}
3372 \\usepackage[mathscr]{eucal}
3373 \\pagestyle{empty}             % do not remove
3374 \[PACKAGES]
3375 \[DEFAULT-PACKAGES]
3376 % The settings below are copied from fullpage.sty
3377 \\setlength{\\textwidth}{\\paperwidth}
3378 \\addtolength{\\textwidth}{-3cm}
3379 \\setlength{\\oddsidemargin}{1.5cm}
3380 \\addtolength{\\oddsidemargin}{-2.54cm}
3381 \\setlength{\\evensidemargin}{\\oddsidemargin}
3382 \\setlength{\\textheight}{\\paperheight}
3383 \\addtolength{\\textheight}{-\\headheight}
3384 \\addtolength{\\textheight}{-\\headsep}
3385 \\addtolength{\\textheight}{-\\footskip}
3386 \\addtolength{\\textheight}{-3cm}
3387 \\setlength{\\topmargin}{1.5cm}
3388 \\addtolength{\\topmargin}{-2.54cm}"
3389   "The document header used for processing LaTeX fragments.
3390 It is imperative that this header make sure that no page number
3391 appears on the page.  The package defined in the variables
3392 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3393 will either replace the placeholder \"[PACKAGES]\" in this header, or they
3394 will be appended."
3395   :group 'org-latex
3396   :type 'string)
3397
3398 (defvar org-format-latex-header-extra nil)
3399
3400 (defun org-set-packages-alist (var val)
3401   "Set the packages alist and make sure it has 3 elements per entry."
3402   (set var (mapcar (lambda (x)
3403                      (if (and (consp x) (= (length x) 2))
3404                          (list (car x) (nth 1 x) t)
3405                        x))
3406                    val)))
3407
3408 (defun org-get-packages-alist (var)
3409
3410   "Get the packages alist and make sure it has 3 elements per entry."
3411   (mapcar (lambda (x)
3412             (if (and (consp x) (= (length x) 2))
3413                 (list (car x) (nth 1 x) t)
3414               x))
3415           (default-value var)))
3416
3417 ;; The following variables are defined here because is it also used
3418 ;; when formatting latex fragments.  Originally it was part of the
3419 ;; LaTeX exporter, which is why the name includes "export".
3420 (defcustom org-export-latex-default-packages-alist
3421   '(("AUTO" "inputenc"  t)
3422     ("T1"   "fontenc"   t)
3423     (""     "fixltx2e"  nil)
3424     (""     "graphicx"  t)
3425     (""     "longtable" nil)
3426     (""     "float"     nil)
3427     (""     "wrapfig"   nil)
3428     (""     "soul"      t)
3429     (""     "textcomp"  t)
3430     (""     "marvosym"  t)
3431     (""     "wasysym"   t)
3432     (""     "latexsym"  t)
3433     (""     "amssymb"   t)
3434     (""     "hyperref"  nil)
3435     "\\tolerance=1000"
3436     )
3437   "Alist of default packages to be inserted in the header.
3438 Change this only if one of the packages here causes an incompatibility
3439 with another package you are using.
3440 The packages in this list are needed by one part or another of Org-mode
3441 to function properly.
3442
3443 - inputenc, fontenc:  for basic font and character selection
3444 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3445   for interpreting the entities in `org-entities'.  You can skip some of these
3446   packages if you don't use any of the symbols in it.
3447 - graphicx: for including images
3448 - float, wrapfig: for figure placement
3449 - longtable: for long tables
3450 - hyperref: for cross references
3451
3452 Therefore you should not modify this variable unless you know what you
3453 are doing.  The one reason to change it anyway is that you might be loading
3454 some other package that conflicts with one of the default packages.
3455 Each cell is of the format \( \"options\" \"package\" snippet-flag\).
3456 If SNIPPET-FLAG is t, the package also needs to be included when
3457 compiling LaTeX snippets into images for inclusion into HTML."
3458   :group 'org-export-latex
3459   :set 'org-set-packages-alist
3460   :get 'org-get-packages-alist
3461   :type '(repeat
3462           (choice
3463            (list :tag "options/package pair"
3464                  (string :tag "options")
3465                  (string :tag "package")
3466                  (boolean :tag "Snippet"))
3467            (string :tag "A line of LaTeX"))))
3468
3469 (defcustom org-export-latex-packages-alist nil
3470   "Alist of packages to be inserted in every LaTeX header.
3471 These will be inserted after `org-export-latex-default-packages-alist'.
3472 Each cell is of the format \( \"options\" \"package\" snippet-flag \).
3473 SNIPPET-FLAG, when t, indicates that this package is also needed when
3474 turning LaTeX snippets into images for inclusion into HTML.
3475 Make sure that you only list packages here which:
3476 - you want in every file
3477 - do not conflict with the default packages in
3478   `org-export-latex-default-packages-alist'
3479 - do not conflict with the setup in `org-format-latex-header'."
3480   :group 'org-export-latex
3481   :set 'org-set-packages-alist
3482   :get 'org-get-packages-alist
3483   :type '(repeat
3484           (choice
3485            (list :tag "options/package pair"
3486                  (string :tag "options")
3487                  (string :tag "package")
3488                  (boolean :tag "Snippet"))
3489            (string :tag "A line of LaTeX"))))
3490
3491
3492 (defgroup org-appearance nil
3493   "Settings for Org-mode appearance."
3494   :tag "Org Appearance"
3495   :group 'org)
3496
3497 (defcustom org-level-color-stars-only nil
3498   "Non-nil means fontify only the stars in each headline.
3499 When nil, the entire headline is fontified.
3500 Changing it requires restart of `font-lock-mode' to become effective
3501 also in regions already fontified."
3502   :group 'org-appearance
3503   :type 'boolean)
3504
3505 (defcustom org-hide-leading-stars nil
3506   "Non-nil means hide the first N-1 stars in a headline.
3507 This works by using the face `org-hide' for these stars.  This
3508 face is white for a light background, and black for a dark
3509 background.  You may have to customize the face `org-hide' to
3510 make this work.
3511 Changing it requires restart of `font-lock-mode' to become effective
3512 also in regions already fontified.
3513 You may also set this on a per-file basis by adding one of the following
3514 lines to the buffer:
3515
3516    #+STARTUP: hidestars
3517    #+STARTUP: showstars"
3518   :group 'org-appearance
3519   :type 'boolean)
3520
3521 (defcustom org-hidden-keywords nil
3522   "List of symbols corresponding to keywords to be hidden the org buffer.
3523 For example, a value '(title) for this list will make the document's title
3524 appear in the buffer without the initial #+TITLE: keyword."
3525   :group 'org-appearance
3526   :type '(set (const :tag "#+AUTHOR" author)
3527               (const :tag "#+DATE" date)
3528               (const :tag "#+EMAIL" email)
3529               (const :tag "#+TITLE" title)))
3530
3531 (defcustom org-fontify-done-headline nil
3532   "Non-nil means change the face of a headline if it is marked DONE.
3533 Normally, only the TODO/DONE keyword indicates the state of a headline.
3534 When this is non-nil, the headline after the keyword is set to the
3535 `org-headline-done' as an additional indication."
3536   :group 'org-appearance
3537   :type 'boolean)
3538
3539 (defcustom org-fontify-emphasized-text t
3540   "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3541 Changing this variable requires a restart of Emacs to take effect."
3542   :group 'org-appearance
3543   :type 'boolean)
3544
3545 (defcustom org-fontify-whole-heading-line nil
3546   "Non-nil means fontify the whole line for headings.
3547 This is useful when setting a background color for the
3548 org-level-* faces."
3549   :group 'org-appearance
3550   :type 'boolean)
3551
3552 (defcustom org-highlight-latex-fragments-and-specials nil
3553   "Non-nil means fontify what is treated specially by the exporters."
3554   :group 'org-appearance
3555   :type 'boolean)
3556
3557 (defcustom org-hide-emphasis-markers nil
3558   "Non-nil mean font-lock should hide the emphasis marker characters."
3559   :group 'org-appearance
3560   :type 'boolean)
3561
3562 (defcustom org-pretty-entities nil
3563   "Non-nil means show entities as UTF8 characters.
3564 When nil, the \\name form remains in the buffer."
3565   :group 'org-appearance
3566   :type 'boolean)
3567
3568 (defcustom org-pretty-entities-include-sub-superscripts t
3569   "Non-nil means, pretty entity display includes formatting sub/superscripts."
3570   :group 'org-appearance
3571   :type 'boolean)
3572
3573 (defvar org-emph-re nil
3574   "Regular expression for matching emphasis.
3575 After a match, the match groups contain these elements:
3576 0  The match of the full regular expression, including the characters
3577      before and after the proper match
3578 1  The character before the proper match, or empty at beginning of line
3579 2  The proper match, including the leading and trailing markers
3580 3  The leading marker like * or /, indicating the type of highlighting
3581 4  The text between the emphasis markers, not including the markers
3582 5  The character after the match, empty at the end of a line")
3583 (defvar org-verbatim-re nil
3584   "Regular expression for matching verbatim text.")
3585 (defvar org-emphasis-regexp-components) ; defined just below
3586 (defvar org-emphasis-alist) ; defined just below
3587 (defun org-set-emph-re (var val)
3588   "Set variable and compute the emphasis regular expression."
3589   (set var val)
3590   (when (and (boundp 'org-emphasis-alist)
3591              (boundp 'org-emphasis-regexp-components)
3592              org-emphasis-alist org-emphasis-regexp-components)
3593     (let* ((e org-emphasis-regexp-components)
3594            (pre (car e))
3595            (post (nth 1 e))
3596            (border (nth 2 e))
3597            (body (nth 3 e))
3598            (nl (nth 4 e))
3599            (body1 (concat body "*?"))
3600            (markers (mapconcat 'car org-emphasis-alist ""))
3601            (vmarkers (mapconcat
3602                       (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
3603                       org-emphasis-alist "")))
3604       ;; make sure special characters appear at the right position in the class
3605       (if (string-match "\\^" markers)
3606           (setq markers (concat (replace-match "" t t markers) "^")))
3607       (if (string-match "-" markers)
3608           (setq markers (concat (replace-match "" t t markers) "-")))
3609       (if (string-match "\\^" vmarkers)
3610           (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
3611       (if (string-match "-" vmarkers)
3612           (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
3613       (if (> nl 0)
3614           (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
3615                               (int-to-string nl) "\\}")))
3616       ;; Make the regexp
3617       (setq org-emph-re
3618             (concat "\\([" pre "]\\|^\\)"
3619                     "\\("
3620                     "\\([" markers "]\\)"
3621                     "\\("
3622                     "[^" border "]\\|"
3623                     "[^" border "]"
3624                     body1
3625                     "[^" border "]"
3626                     "\\)"
3627                     "\\3\\)"
3628                     "\\([" post "]\\|$\\)"))
3629       (setq org-verbatim-re
3630             (concat "\\([" pre "]\\|^\\)"
3631                     "\\("
3632                     "\\([" vmarkers "]\\)"
3633                     "\\("
3634                     "[^" border "]\\|"
3635                     "[^" border "]"
3636                     body1
3637                     "[^" border "]"
3638                     "\\)"
3639                     "\\3\\)"
3640                     "\\([" post  "]\\|$\\)")))))
3641
3642 (defcustom org-emphasis-regexp-components
3643   '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
3644   "Components used to build the regular expression for emphasis.
3645 This is a list with five entries.  Terminology:  In an emphasis string
3646 like \" *strong word* \", we call the initial space PREMATCH, the final
3647 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
3648 and \"trong wor\" is the body.  The different components in this variable
3649 specify what is allowed/forbidden in each part:
3650
3651 pre          Chars allowed as prematch.  Beginning of line will be allowed too.
3652 post         Chars allowed as postmatch.  End of line will be allowed too.
3653 border       The chars *forbidden* as border characters.
3654 body-regexp  A regexp like \".\" to match a body character.  Don't use
3655              non-shy groups here, and don't allow newline here.
3656 newline      The maximum number of newlines allowed in an emphasis exp.
3657
3658 Use customize to modify this, or restart Emacs after changing it."
3659   :group 'org-appearance
3660   :set 'org-set-emph-re
3661   :type '(list
3662           (sexp    :tag "Allowed chars in pre      ")
3663           (sexp    :tag "Allowed chars in post     ")
3664           (sexp    :tag "Forbidden chars in border ")
3665           (sexp    :tag "Regexp for body           ")
3666           (integer :tag "number of newlines allowed")
3667           (option (boolean :tag "Please ignore this button"))))
3668
3669 (defcustom org-emphasis-alist
3670   `(("*" bold "<b>" "</b>")
3671     ("/" italic "<i>" "</i>")
3672     ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
3673     ("=" org-code "<code>" "</code>" verbatim)
3674     ("~" org-verbatim "<code>" "</code>" verbatim)
3675     ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
3676      "<del>" "</del>")
3677     )
3678   "Special syntax for emphasized text.
3679 Text starting and ending with a special character will be emphasized, for
3680 example *bold*, _underlined_ and /italic/.  This variable sets the marker
3681 characters, the face to be used by font-lock for highlighting in Org-mode
3682 Emacs buffers, and the HTML tags to be used for this.
3683 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3684 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3685 Use customize to modify this, or restart Emacs after changing it."
3686   :group 'org-appearance
3687   :set 'org-set-emph-re
3688   :type '(repeat
3689           (list
3690            (string :tag "Marker character")
3691            (choice
3692             (face :tag "Font-lock-face")
3693             (plist :tag "Face property list"))
3694            (string :tag "HTML start tag")
3695            (string :tag "HTML end tag")
3696            (option (const verbatim)))))
3697
3698 (defvar org-protecting-blocks
3699   '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
3700   "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3701 This is needed for font-lock setup.")
3702
3703 ;;; Miscellaneous options
3704
3705 (defgroup org-completion nil
3706   "Completion in Org-mode."
3707   :tag "Org Completion"
3708   :group 'org)
3709
3710 (defcustom org-completion-use-ido nil
3711   "Non-nil means use ido completion wherever possible.
3712 Note that `ido-mode' must be active for this variable to be relevant.
3713 If you decide to turn this variable on, you might well want to turn off
3714 `org-outline-path-complete-in-steps'.
3715 See also `org-completion-use-iswitchb'."
3716   :group 'org-completion
3717   :type 'boolean)
3718
3719 (defcustom org-completion-use-iswitchb nil
3720   "Non-nil means use iswitchb completion wherever possible.
3721 Note that `iswitchb-mode' must be active for this variable to be relevant.
3722 If you decide to turn this variable on, you might well want to turn off
3723 `org-outline-path-complete-in-steps'.
3724 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3725   :group 'org-completion
3726   :type 'boolean)
3727
3728 (defcustom org-completion-fallback-command 'hippie-expand
3729   "The expansion command called by \\[pcomplete] in normal context.
3730 Normal means, no org-mode-specific context."
3731   :group 'org-completion
3732   :type 'function)
3733
3734 ;;; Functions and variables from their packages
3735 ;;  Declared here to avoid compiler warnings
3736
3737 ;; XEmacs only
3738 (defvar outline-mode-menu-heading)
3739 (defvar outline-mode-menu-show)
3740 (defvar outline-mode-menu-hide)
3741 (defvar zmacs-regions) ; XEmacs regions
3742
3743 ;; Emacs only
3744 (defvar mark-active)
3745
3746 ;; Various packages
3747 (declare-function calendar-absolute-from-iso    "cal-iso"    (date))
3748 (declare-function calendar-forward-day          "cal-move"   (arg))
3749 (declare-function calendar-goto-date            "cal-move"   (date))
3750 (declare-function calendar-goto-today           "cal-move"   ())
3751 (declare-function calendar-iso-from-absolute    "cal-iso"    (date))
3752 (defvar calc-embedded-close-formula)
3753 (defvar calc-embedded-open-formula)
3754 (declare-function cdlatex-tab "ext:cdlatex" ())
3755 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
3756 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
3757 (defvar font-lock-unfontify-region-function)
3758 (declare-function iswitchb-read-buffer "iswitchb"
3759                   (prompt &optional default require-match start matches-set))
3760 (defvar iswitchb-temp-buflist)
3761 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
3762 (defvar org-agenda-tags-todo-honor-ignore-options)
3763 (declare-function org-agenda-skip "org-agenda" ())
3764 (declare-function
3765  org-agenda-format-item "org-agenda"
3766  (extra txt &optional category tags dotime noprefix remove-re habitp))
3767 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
3768 (declare-function org-agenda-change-all-lines "org-agenda"
3769                   (newhead hdmarker &optional fixface just-this))
3770 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
3771 (declare-function org-agenda-maybe-redo "org-agenda" ())
3772 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
3773                   (beg end))
3774 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
3775 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
3776                   "org-agenda" (&optional end))
3777 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
3778 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
3779 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
3780 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
3781 (declare-function org-indent-mode "org-indent" (&optional arg))
3782 (declare-function parse-time-string "parse-time" (string))
3783 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
3784 (declare-function org-export-latex-fix-inputenc "org-latex" ())
3785 (declare-function orgtbl-send-table "org-table" (&optional maybe))
3786 (defvar remember-data-file)
3787 (defvar texmathp-why)
3788 (declare-function speedbar-line-directory "speedbar" (&optional depth))
3789 (declare-function table--at-cell-p "table" (position &optional object at-column))
3790
3791 (defvar w3m-current-url)
3792 (defvar w3m-current-title)
3793
3794 (defvar org-latex-regexps)
3795
3796 ;;; Autoload and prepare some org modules
3797
3798 ;; Some table stuff that needs to be defined here, because it is used
3799 ;; by the functions setting up org-mode or checking for table context.
3800
3801 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
3802   "Detect an org-type or table-type table.")
3803 (defconst org-table-line-regexp "^[ \t]*|"
3804   "Detect an org-type table line.")
3805 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
3806   "Detect an org-type table line.")
3807 (defconst org-table-hline-regexp "^[ \t]*|-"
3808   "Detect an org-type table hline.")
3809 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
3810   "Detect a table-type table hline.")
3811 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
3812   "Detect the first line outside a table when searching from within it.
3813 This works for both table types.")
3814
3815 ;; Autoload the functions in org-table.el that are needed by functions here.
3816
3817 (eval-and-compile
3818   (org-autoload "org-table"
3819                 '(org-table-align org-table-begin org-table-blank-field
3820    org-table-convert org-table-convert-region org-table-copy-down
3821    org-table-copy-region org-table-create
3822    org-table-create-or-convert-from-region
3823    org-table-create-with-table.el org-table-current-dline
3824    org-table-cut-region org-table-delete-column org-table-edit-field
3825    org-table-edit-formulas org-table-end org-table-eval-formula
3826    org-table-export org-table-field-info
3827    org-table-get-stored-formulas org-table-goto-column
3828    org-table-hline-and-move org-table-import org-table-insert-column
3829    org-table-insert-hline org-table-insert-row org-table-iterate
3830    org-table-justify-field-maybe org-table-kill-row
3831    org-table-maybe-eval-formula org-table-maybe-recalculate-line
3832    org-table-move-column org-table-move-column-left
3833    org-table-move-column-right org-table-move-row
3834    org-table-move-row-down org-table-move-row-up
3835    org-table-next-field org-table-next-row org-table-paste-rectangle
3836    org-table-previous-field org-table-recalculate
3837    org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3838    org-table-toggle-coordinate-overlays
3839    org-table-toggle-formula-debugger org-table-wrap-region
3840    orgtbl-mode turn-on-orgtbl org-table-to-lisp
3841    orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3842    orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3843
3844 (defun org-at-table-p (&optional table-type)
3845   "Return t if the cursor is inside an org-type table.
3846 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3847   (if org-enable-table-editor
3848       (save-excursion
3849         (beginning-of-line 1)
3850         (looking-at (if table-type org-table-any-line-regexp
3851                       org-table-line-regexp)))
3852     nil))
3853 (defsubst org-table-p () (org-at-table-p))
3854
3855 (defun org-at-table.el-p ()
3856   "Return t if and only if we are at a table.el table."
3857   (and (org-at-table-p 'any)
3858        (save-excursion
3859          (goto-char (org-table-begin 'any))
3860          (looking-at org-table1-hline-regexp))))
3861 (defun org-table-recognize-table.el ()
3862   "If there is a table.el table nearby, recognize it and move into it."
3863   (if org-table-tab-recognizes-table.el
3864       (if (org-at-table.el-p)
3865           (progn
3866             (beginning-of-line 1)
3867             (if (looking-at org-table-dataline-regexp)
3868                 nil
3869               (if (looking-at org-table1-hline-regexp)
3870                   (progn
3871                     (beginning-of-line 2)
3872                     (if (looking-at org-table-any-border-regexp)
3873                         (beginning-of-line -1)))))
3874             (if (re-search-forward "|" (org-table-end t) t)
3875                 (progn
3876                   (require 'table)
3877                   (if (table--at-cell-p (point))
3878                       t
3879                     (message "recognizing table.el table...")
3880                     (table-recognize-table)
3881                     (message "recognizing table.el table...done")))
3882               (error "This should not happen"))
3883             t)
3884         nil)
3885     nil))
3886
3887 (defun org-at-table-hline-p ()
3888   "Return t if the cursor is inside a hline in a table."
3889   (if org-enable-table-editor
3890       (save-excursion
3891         (beginning-of-line 1)
3892         (looking-at org-table-hline-regexp))
3893     nil))
3894
3895 (defvar org-table-clean-did-remove-column nil)
3896
3897 (defun org-table-map-tables (function &optional quietly)
3898   "Apply FUNCTION to the start of all tables in the buffer."
3899   (save-excursion
3900     (save-restriction
3901       (widen)
3902       (goto-char (point-min))
3903       (while (re-search-forward org-table-any-line-regexp nil t)
3904         (unless quietly
3905           (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
3906         (beginning-of-line 1)
3907         (when (looking-at org-table-line-regexp)
3908           (save-excursion (funcall function))
3909           (or (looking-at org-table-line-regexp)
3910               (forward-char 1)))
3911         (re-search-forward org-table-any-border-regexp nil 1))))
3912   (unless quietly (message "Mapping tables: done")))
3913
3914 ;; Declare and autoload functions from org-exp.el  & Co
3915
3916 (declare-function org-default-export-plist "org-exp")
3917 (declare-function org-infile-export-plist "org-exp")
3918 (declare-function org-get-current-options "org-exp")
3919 (eval-and-compile
3920   (org-autoload "org-exp"
3921                 '(org-export org-export-visible
3922                              org-insert-export-options-template
3923                              org-table-clean-before-export))
3924   (org-autoload "org-ascii"
3925                 '(org-export-as-ascii org-export-ascii-preprocess
3926                   org-export-as-ascii-to-buffer org-replace-region-by-ascii
3927                   org-export-region-as-ascii))
3928   (org-autoload "org-latex"
3929                 '(org-export-as-latex-batch org-export-as-latex-to-buffer
3930                   org-replace-region-by-latex org-export-region-as-latex
3931                   org-export-as-latex org-export-as-pdf
3932                   org-export-as-pdf-and-open))
3933   (org-autoload "org-html"
3934                 '(org-export-as-html-and-open
3935                   org-export-as-html-batch org-export-as-html-to-buffer
3936                   org-replace-region-by-html org-export-region-as-html
3937                   org-export-as-html))
3938   (org-autoload "org-docbook"
3939                 '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
3940                   org-replace-region-by-docbook org-export-region-as-docbook
3941                   org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3942                   org-export-as-docbook))
3943   (org-autoload "org-icalendar"
3944                 '(org-export-icalendar-this-file
3945                   org-export-icalendar-all-agenda-files
3946                   org-export-icalendar-combine-agenda-files))
3947   (org-autoload "org-xoxo" '(org-export-as-xoxo))
3948   (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
3949
3950 ;; Declare and autoload functions from org-agenda.el
3951
3952 (eval-and-compile
3953   (org-autoload "org-agenda"
3954                 '(org-agenda org-agenda-list org-search-view
3955    org-todo-list org-tags-view org-agenda-list-stuck-projects
3956    org-diary org-agenda-to-appt
3957    org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3958
3959 ;; Autoload org-remember
3960
3961 (eval-and-compile
3962   (org-autoload "org-remember"
3963                 '(org-remember-insinuate org-remember-annotation
3964    org-remember-apply-template org-remember org-remember-handler)))
3965
3966 (eval-and-compile
3967   (org-autoload "org-capture"
3968                 '(org-capture org-capture-insert-template-here
3969                   org-capture-import-remember-templates)))
3970
3971 ;; Autoload org-clock.el
3972
3973 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
3974                   (beg end))
3975 (declare-function org-clock-update-mode-line "org-clock" ())
3976 (declare-function org-resolve-clocks "org-clock"
3977                   (&optional also-non-dangling-p prompt last-valid))
3978 (defvar org-clock-start-time)
3979 (defvar org-clock-marker (make-marker)
3980   "Marker recording the last clock-in.")
3981 (defvar org-clock-hd-marker (make-marker)
3982   "Marker recording the last clock-in, but the headline position.")
3983 (defvar org-clock-heading ""
3984   "The heading of the current clock entry.")
3985 (defun org-clock-is-active ()
3986  "Return non-nil if clock is currently running.
3987 The return value is actually the clock marker."
3988  (marker-buffer org-clock-marker))
3989
3990 (eval-and-compile
3991   (org-autoload
3992    "org-clock"
3993    '(org-clock-in org-clock-out org-clock-cancel
3994                   org-clock-goto org-clock-sum org-clock-display
3995                   org-clock-remove-overlays org-clock-report
3996                   org-clocktable-shift org-dblock-write:clocktable
3997                   org-get-clocktable org-resolve-clocks)))
3998
3999 (defun org-clock-update-time-maybe ()
4000   "If this is a CLOCK line, update it and return t.
4001 Otherwise, return nil."
4002   (interactive)
4003   (save-excursion
4004     (beginning-of-line 1)
4005     (skip-chars-forward " \t")
4006     (when (looking-at org-clock-string)
4007       (let ((re (concat "[ \t]*" org-clock-string
4008                         " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
4009                         "\\([ \t]*=>.*\\)?\\)?"))
4010             ts te h m s neg)
4011         (cond
4012          ((not (looking-at re))
4013           nil)
4014          ((not (match-end 2))
4015           (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4016                      (> org-clock-marker (point))
4017                      (<= org-clock-marker (point-at-eol)))
4018             ;; The clock is running here
4019             (setq org-clock-start-time
4020                   (apply 'encode-time
4021                          (org-parse-time-string (match-string 1))))
4022             (org-clock-update-mode-line)))
4023          (t
4024           (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
4025           (end-of-line 1)
4026           (setq ts (match-string 1)
4027                 te (match-string 3))
4028           (setq s (- (org-float-time
4029                       (apply 'encode-time (org-parse-time-string te)))
4030                      (org-float-time
4031                       (apply 'encode-time (org-parse-time-string ts))))
4032                 neg (< s 0)
4033                 s (abs s)
4034                 h (floor (/ s 3600))
4035                 s (- s (* 3600 h))
4036                 m (floor (/ s 60))
4037                 s (- s (* 60 s)))
4038           (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
4039           t))))))
4040
4041 (defun org-check-running-clock ()
4042   "Check if the current buffer contains the running clock.
4043 If yes, offer to stop it and to save the buffer with the changes."
4044   (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4045              (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4046                                (buffer-name))))
4047     (org-clock-out)
4048     (when (y-or-n-p "Save changed buffer?")
4049       (save-buffer))))
4050
4051 (defun org-clocktable-try-shift (dir n)
4052   "Check if this line starts a clock table, if yes, shift the time block."
4053   (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4054     (org-clocktable-shift dir n)))
4055
4056 ;; Autoload org-timer.el
4057
4058 (eval-and-compile
4059   (org-autoload
4060    "org-timer"
4061    '(org-timer-start org-timer org-timer-item
4062                      org-timer-change-times-in-region
4063                      org-timer-set-timer
4064                      org-timer-reset-timers
4065                      org-timer-show-remaining-time)))
4066
4067 ;; Autoload org-feed.el
4068
4069 (eval-and-compile
4070   (org-autoload
4071    "org-feed"
4072    '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
4073
4074
4075 ;; Autoload org-indent.el
4076
4077 ;; Define the variable already here, to make sure we have it.
4078 (defvar org-indent-mode nil
4079   "Non-nil if Org-Indent mode is enabled.
4080 Use the command `org-indent-mode' to change this variable.")
4081
4082 (eval-and-compile
4083   (org-autoload
4084    "org-indent"
4085    '(org-indent-mode)))
4086
4087 ;; Autoload org-mobile.el
4088
4089 (eval-and-compile
4090   (org-autoload
4091    "org-mobile"
4092    '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
4093
4094 ;; Autoload archiving code
4095 ;; The stuff that is needed for cycling and tags has to be defined here.
4096
4097 (defgroup org-archive nil
4098   "Options concerning archiving in Org-mode."
4099   :tag "Org Archive"
4100   :group 'org-structure)
4101
4102 (defcustom org-archive-location "%s_archive::"
4103   "The location where subtrees should be archived.
4104
4105 The value of this variable is a string, consisting of two parts,
4106 separated by a double-colon.  The first part is a filename and
4107 the second part is a headline.
4108
4109 When the filename is omitted, archiving happens in the same file.
4110 %s in the filename will be replaced by the cu