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