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