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