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