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