org-attach: Make use of git optional
[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)
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 "24.4"
783   :package-version '(Org . "8.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 '((isearch . lineage)
1155                                      (bookmark-jump . lineage)
1156                                      (default . ancestors))
1157   "Alist between context and visibility span when revealing a location.
1158
1159 \\<org-mode-map>Some actions may move point into invisible
1160 locations.  As a consequence, Org always expose a neighborhood
1161 around point.  How much is shown depends on the initial action,
1162 or context.  Valid contexts are
1163
1164   agenda         when exposing an entry from the agenda
1165   org-goto       when using the command `org-goto' (\\[org-goto])
1166   occur-tree     when using the command `org-occur' (\\[org-sparse-tree] /)
1167   tags-tree      when constructing a sparse tree based on tags matches
1168   link-search    when exposing search matches associated with a link
1169   mark-goto      when exposing the jump goal of a mark
1170   bookmark-jump  when exposing a bookmark location
1171   isearch        when exiting from an incremental search
1172   default        default for all contexts not set explicitly
1173
1174 Allowed visibility spans are
1175
1176   minimal        show current headline; if point is not on headline,
1177                  also show entry
1178
1179   local          show current headline, entry and next headline
1180
1181   ancestors      show current headline and its direct ancestors; if
1182                  point is not on headline, also show entry
1183
1184   lineage        show current headline, its direct ancestors and all
1185                  their children; if point is not on headline, also show
1186                  entry and first child
1187
1188   tree           show current headline, its direct ancestors and all
1189                  their children; if point is not on headline, also show
1190                  entry and all children
1191
1192   canonical      show current headline, its direct ancestors along with
1193                  their entries and children; if point is not located on
1194                  the headline, also show current entry and all children
1195
1196 As special cases, a nil or t value means show all contexts in
1197 `minimal' or `canonical' view, respectively.
1198
1199 Some views can make displayed information very compact, but also
1200 make it harder to edit the location of the match.  In such
1201 a case, use the command `org-reveal' (\\[org-reveal]) to show
1202 more context."
1203   :group 'org-reveal-location
1204   :version "25.1"
1205   :package-version '(Org . "8.3")
1206   :type '(choice
1207           (const :tag "Canonical" t)
1208           (const :tag "Minimal" nil)
1209           (repeat :greedy t :tag "Individual contexts"
1210                   (cons
1211                    (choice :tag "Context"
1212                            (const agenda)
1213                            (const org-goto)
1214                            (const occur-tree)
1215                            (const tags-tree)
1216                            (const link-search)
1217                            (const mark-goto)
1218                            (const bookmark-jump)
1219                            (const isearch)
1220                            (const default))
1221                    (choice :tag "Detail level"
1222                            (const minimal)
1223                            (const local)
1224                            (const ancestors)
1225                            (const lineage)
1226                            (const tree)
1227                            (const canonical))))))
1228
1229 (defcustom org-indirect-buffer-display 'other-window
1230   "How should indirect tree buffers be displayed?
1231 This applies to indirect buffers created with the commands
1232 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1233 Valid values are:
1234 current-window   Display in the current window
1235 other-window     Just display in another window.
1236 dedicated-frame  Create one new frame, and re-use it each time.
1237 new-frame        Make a new frame each time.  Note that in this case
1238                  previously-made indirect buffers are kept, and you need to
1239                  kill these buffers yourself."
1240   :group 'org-structure
1241   :group 'org-agenda-windows
1242   :type '(choice
1243           (const :tag "In current window" current-window)
1244           (const :tag "In current frame, other window" other-window)
1245           (const :tag "Each time a new frame" new-frame)
1246           (const :tag "One dedicated frame" dedicated-frame)))
1247
1248 (defcustom org-use-speed-commands nil
1249   "Non-nil means activate single letter commands at beginning of a headline.
1250 This may also be a function to test for appropriate locations where speed
1251 commands should be active.
1252
1253 For example, to activate speed commands when the point is on any
1254 star at the beginning of the headline, you can do this:
1255
1256   (setq org-use-speed-commands
1257       (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1258   :group 'org-structure
1259   :type '(choice
1260           (const :tag "Never" nil)
1261           (const :tag "At beginning of headline stars" t)
1262           (function)))
1263
1264 (defcustom org-speed-commands-user nil
1265   "Alist of additional speed commands.
1266 This list will be checked before `org-speed-commands-default'
1267 when the variable `org-use-speed-commands' is non-nil
1268 and when the cursor is at the beginning of a headline.
1269 The car if each entry is a string with a single letter, which must
1270 be assigned to `self-insert-command' in the global map.
1271 The cdr is either a command to be called interactively, a function
1272 to be called, or a form to be evaluated.
1273 An entry that is just a list with a single string will be interpreted
1274 as a descriptive headline that will be added when listing the speed
1275 commands in the Help buffer using the `?' speed command."
1276   :group 'org-structure
1277   :type '(repeat :value ("k" . ignore)
1278                  (choice :value ("k" . ignore)
1279                          (list :tag "Descriptive Headline" (string :tag "Headline"))
1280                          (cons :tag "Letter and Command"
1281                                (string :tag "Command letter")
1282                                (choice
1283                                 (function)
1284                                 (sexp))))))
1285
1286 (defcustom org-bookmark-names-plist
1287   '(:last-capture "org-capture-last-stored"
1288                   :last-refile "org-refile-last-stored"
1289                   :last-capture-marker "org-capture-last-stored-marker")
1290   "Names for bookmarks automatically set by some Org commands.
1291 This can provide strings as names for a number of bookmarks Org sets
1292 automatically.  The following keys are currently implemented:
1293   :last-capture
1294   :last-capture-marker
1295   :last-refile
1296 When a key does not show up in the property list, the corresponding bookmark
1297 is not set."
1298   :group 'org-structure
1299   :type 'plist)
1300
1301 (defgroup org-cycle nil
1302   "Options concerning visibility cycling in Org-mode."
1303   :tag "Org Cycle"
1304   :group 'org-structure)
1305
1306 (defcustom org-cycle-skip-children-state-if-no-children t
1307   "Non-nil means skip CHILDREN state in entries that don't have any."
1308   :group 'org-cycle
1309   :type 'boolean)
1310
1311 (defcustom org-cycle-max-level nil
1312   "Maximum level which should still be subject to visibility cycling.
1313 Levels higher than this will, for cycling, be treated as text, not a headline.
1314 When `org-odd-levels-only' is set, a value of N in this variable actually
1315 means 2N-1 stars as the limiting headline.
1316 When nil, cycle all levels.
1317 Note that the limiting level of cycling is also influenced by
1318 `org-inlinetask-min-level'.  When `org-cycle-max-level' is not set but
1319 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1320 than its value."
1321   :group 'org-cycle
1322   :type '(choice
1323           (const :tag "No limit" nil)
1324           (integer :tag "Maximum level")))
1325
1326 (defcustom org-hide-block-startup nil
1327   "Non-nil means entering Org-mode will fold all blocks.
1328 This can also be set in on a per-file basis with
1329
1330 #+STARTUP: hideblocks
1331 #+STARTUP: showblocks"
1332   :group 'org-startup
1333   :group 'org-cycle
1334   :type 'boolean)
1335
1336 (defcustom org-cycle-global-at-bob nil
1337   "Cycle globally if cursor is at beginning of buffer and not at a headline.
1338 This makes it possible to do global cycling without having to use S-TAB or
1339 \\[universal-argument] TAB.  For this special case to work, the first line
1340 of the buffer must not be a headline -- it may be empty or some other text.
1341 When used in this way, `org-cycle-hook' is disabled temporarily to make
1342 sure the cursor stays at the beginning of the buffer.  When this option is
1343 nil, don't do anything special at the beginning of the buffer."
1344   :group 'org-cycle
1345   :type 'boolean)
1346
1347 (defcustom org-cycle-level-after-item/entry-creation t
1348   "Non-nil means cycle entry level or item indentation in new empty entries.
1349
1350 When the cursor is at the end of an empty headline, i.e., with only stars
1351 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1352 and then all possible ancestor states, before returning to the original state.
1353 This makes data entry extremely fast:  M-RET to create a new headline,
1354 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1355
1356 When the cursor is at the end of an empty plain list item, one TAB will
1357 make it a subitem, two or more tabs will back up to make this an item
1358 higher up in the item hierarchy."
1359   :group 'org-cycle
1360   :type 'boolean)
1361
1362 (defcustom org-cycle-emulate-tab t
1363   "Where should `org-cycle' emulate TAB.
1364 nil         Never
1365 white       Only in completely white lines
1366 whitestart  Only at the beginning of lines, before the first non-white char
1367 t           Everywhere except in headlines
1368 exc-hl-bol  Everywhere except at the start of a headline
1369 If TAB is used in a place where it does not emulate TAB, the current subtree
1370 visibility is cycled."
1371   :group 'org-cycle
1372   :type '(choice (const :tag "Never" nil)
1373                  (const :tag "Only in completely white lines" white)
1374                  (const :tag "Before first char in a line" whitestart)
1375                  (const :tag "Everywhere except in headlines" t)
1376                  (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1377
1378 (defcustom org-cycle-separator-lines 2
1379   "Number of empty lines needed to keep an empty line between collapsed trees.
1380 If you leave an empty line between the end of a subtree and the following
1381 headline, this empty line is hidden when the subtree is folded.
1382 Org-mode will leave (exactly) one empty line visible if the number of
1383 empty lines is equal or larger to the number given in this variable.
1384 So the default 2 means at least 2 empty lines after the end of a subtree
1385 are needed to produce free space between a collapsed subtree and the
1386 following headline.
1387
1388 If the number is negative, and the number of empty lines is at least -N,
1389 all empty lines are shown.
1390
1391 Special case: when 0, never leave empty lines in collapsed view."
1392   :group 'org-cycle
1393   :type 'integer)
1394 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1395
1396 (defcustom org-pre-cycle-hook nil
1397   "Hook that is run before visibility cycling is happening.
1398 The function(s) in this hook must accept a single argument which indicates
1399 the new state that will be set right after running this hook.  The
1400 argument is a symbol.  Before a global state change, it can have the values
1401 `overview', `content', or `all'.  Before a local state change, it can have
1402 the values `folded', `children', or `subtree'."
1403   :group 'org-cycle
1404   :type 'hook)
1405
1406 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1407                             org-cycle-hide-drawers
1408                             org-cycle-show-empty-lines
1409                             org-optimize-window-after-visibility-change)
1410   "Hook that is run after `org-cycle' has changed the buffer visibility.
1411 The function(s) in this hook must accept a single argument which indicates
1412 the new state that was set by the most recent `org-cycle' command.  The
1413 argument is a symbol.  After a global state change, it can have the values
1414 `overview', `contents', or `all'.  After a local state change, it can have
1415 the values `folded', `children', or `subtree'."
1416   :group 'org-cycle
1417   :type 'hook
1418   :version "25.1"
1419   :package-version '(Org . "8.3"))
1420
1421 (defgroup org-edit-structure nil
1422   "Options concerning structure editing in Org-mode."
1423   :tag "Org Edit Structure"
1424   :group 'org-structure)
1425
1426 (defcustom org-odd-levels-only nil
1427   "Non-nil means skip even levels and only use odd levels for the outline.
1428 This has the effect that two stars are being added/taken away in
1429 promotion/demotion commands.  It also influences how levels are
1430 handled by the exporters.
1431 Changing it requires restart of `font-lock-mode' to become effective
1432 for fontification also in regions already fontified.
1433 You may also set this on a per-file basis by adding one of the following
1434 lines to the buffer:
1435
1436    #+STARTUP: odd
1437    #+STARTUP: oddeven"
1438   :group 'org-edit-structure
1439   :group 'org-appearance
1440   :type 'boolean)
1441
1442 (defcustom org-adapt-indentation t
1443   "Non-nil means adapt indentation to outline node level.
1444
1445 When this variable is set, Org assumes that you write outlines by
1446 indenting text in each node to align with the headline (after the
1447 stars).  The following issues are influenced by this variable:
1448
1449 - The indentation is increased by one space in a demotion
1450   command, and decreased by one in a promotion command.  However,
1451   in the latter case, if shifting some line in the entry body
1452   would alter document structure (e.g., insert a new headline),
1453   indentation is not changed at all.
1454
1455 - Property drawers and planning information is inserted indented
1456   when this variable is set.  When nil, they will not be indented.
1457
1458 - TAB indents a line relative to current level.  The lines below
1459   a headline will be indented when this variable is set.
1460
1461 Note that this is all about true indentation, by adding and
1462 removing space characters.  See also `org-indent.el' which does
1463 level-dependent indentation in a virtual way, i.e. at display
1464 time in Emacs."
1465   :group 'org-edit-structure
1466   :type 'boolean)
1467
1468 (defcustom org-special-ctrl-a/e nil
1469   "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1470
1471 When t, `C-a' will bring back the cursor to the beginning of the
1472 headline text, i.e. after the stars and after a possible TODO
1473 keyword.  In an item, this will be the position after bullet and
1474 check-box, if any.  When the cursor is already at that position,
1475 another `C-a' will bring it to the beginning of the line.
1476
1477 `C-e' will jump to the end of the headline, ignoring the presence
1478 of tags in the headline.  A second `C-e' will then jump to the
1479 true end of the line, after any tags.  This also means that, when
1480 this variable is non-nil, `C-e' also will never jump beyond the
1481 end of the heading of a folded section, i.e. not after the
1482 ellipses.
1483
1484 When set to the symbol `reversed', the first `C-a' or `C-e' works
1485 normally, going to the true line boundary first.  Only a directly
1486 following, identical keypress will bring the cursor to the
1487 special positions.
1488
1489 This may also be a cons cell where the behavior for `C-a' and
1490 `C-e' is set separately."
1491   :group 'org-edit-structure
1492   :type '(choice
1493           (const :tag "off" nil)
1494           (const :tag "on: after stars/bullet and before tags first" t)
1495           (const :tag "reversed: true line boundary first" reversed)
1496           (cons :tag "Set C-a and C-e separately"
1497                 (choice :tag "Special C-a"
1498                         (const :tag "off" nil)
1499                         (const :tag "on: after  stars/bullet first" t)
1500                         (const :tag "reversed: before stars/bullet first" reversed))
1501                 (choice :tag "Special C-e"
1502                         (const :tag "off" nil)
1503                         (const :tag "on: before tags first" t)
1504                         (const :tag "reversed: after tags first" reversed)))))
1505 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1506
1507 (defcustom org-special-ctrl-k nil
1508   "Non-nil means `C-k' will behave specially in headlines.
1509 When nil, `C-k' will call the default `kill-line' command.
1510 When t, the following will happen while the cursor is in the headline:
1511
1512 - When the cursor is at the beginning of a headline, kill the entire
1513   line and possible the folded subtree below the line.
1514 - When in the middle of the headline text, kill the headline up to the tags.
1515 - When after the headline text, kill the tags."
1516   :group 'org-edit-structure
1517   :type 'boolean)
1518
1519 (defcustom org-ctrl-k-protect-subtree nil
1520   "Non-nil means, do not delete a hidden subtree with C-k.
1521 When set to the symbol `error', simply throw an error when C-k is
1522 used to kill (part-of) a headline that has hidden text behind it.
1523 Any other non-nil value will result in a query to the user, if it is
1524 OK to kill that hidden subtree.  When nil, kill without remorse."
1525   :group 'org-edit-structure
1526   :version "24.1"
1527   :type '(choice
1528           (const :tag "Do not protect hidden subtrees" nil)
1529           (const :tag "Protect hidden subtrees with a security query" t)
1530           (const :tag "Never kill a hidden subtree with C-k" error)))
1531
1532 (defcustom org-special-ctrl-o t
1533   "Non-nil means, make `C-o' insert a row in tables."
1534   :group 'org-edit-structure
1535   :type 'boolean)
1536
1537 (defcustom org-catch-invisible-edits nil
1538   "Check if in invisible region before inserting or deleting a character.
1539 Valid values are:
1540
1541 nil              Do not check, so just do invisible edits.
1542 error            Throw an error and do nothing.
1543 show             Make point visible, and do the requested edit.
1544 show-and-error   Make point visible, then throw an error and abort the edit.
1545 smart            Make point visible, and do insertion/deletion if it is
1546                  adjacent to visible text and the change feels predictable.
1547                  Never delete a previously invisible character or add in the
1548                  middle or right after an invisible region.  Basically, this
1549                  allows insertion and backward-delete right before ellipses.
1550                  FIXME: maybe in this case we should not even show?"
1551   :group 'org-edit-structure
1552   :version "24.1"
1553   :type '(choice
1554           (const :tag "Do not check" nil)
1555           (const :tag "Throw error when trying to edit" error)
1556           (const :tag "Unhide, but do not do the edit" show-and-error)
1557           (const :tag "Show invisible part and do the edit" show)
1558           (const :tag "Be smart and do the right thing" smart)))
1559
1560 (defcustom org-yank-folded-subtrees t
1561   "Non-nil means when yanking subtrees, fold them.
1562 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1563 it starts with a heading and all other headings in it are either children
1564 or siblings, then fold all the subtrees.  However, do this only if no
1565 text after the yank would be swallowed into a folded tree by this action."
1566   :group 'org-edit-structure
1567   :type 'boolean)
1568
1569 (defcustom org-yank-adjusted-subtrees nil
1570   "Non-nil means when yanking subtrees, adjust the level.
1571 With this setting, `org-paste-subtree' is used to insert the subtree, see
1572 this function for details."
1573   :group 'org-edit-structure
1574   :type 'boolean)
1575
1576 (defcustom org-M-RET-may-split-line '((default . t))
1577   "Non-nil means M-RET will split the line at the cursor position.
1578 When nil, it will go to the end of the line before making a
1579 new line.
1580 You may also set this option in a different way for different
1581 contexts.  Valid contexts are:
1582
1583 headline  when creating a new headline
1584 item      when creating a new item
1585 table     in a table field
1586 default   the value to be used for all contexts not explicitly
1587           customized"
1588   :group 'org-structure
1589   :group 'org-table
1590   :type '(choice
1591           (const :tag "Always" t)
1592           (const :tag "Never" nil)
1593           (repeat :greedy t :tag "Individual contexts"
1594                   (cons
1595                    (choice :tag "Context"
1596                            (const headline)
1597                            (const item)
1598                            (const table)
1599                            (const default))
1600                    (boolean)))))
1601
1602
1603 (defcustom org-insert-heading-respect-content nil
1604   "Non-nil means insert new headings after the current subtree.
1605 When nil, the new heading is created directly after the current line.
1606 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1607 this variable on for the duration of the command."
1608   :group 'org-structure
1609   :type 'boolean)
1610
1611 (defcustom org-blank-before-new-entry '((heading . auto)
1612                                         (plain-list-item . auto))
1613   "Should `org-insert-heading' leave a blank line before new heading/item?
1614 The value is an alist, with `heading' and `plain-list-item' as CAR,
1615 and a boolean flag as CDR.  The cdr may also be the symbol `auto', in
1616 which case Org will look at the surrounding headings/items and try to
1617 make an intelligent decision whether to insert a blank line or not."
1618   :group 'org-edit-structure
1619   :type '(list
1620           (cons (const heading)
1621                 (choice (const :tag "Never" nil)
1622                         (const :tag "Always" t)
1623                         (const :tag "Auto" auto)))
1624           (cons (const plain-list-item)
1625                 (choice (const :tag "Never" nil)
1626                         (const :tag "Always" t)
1627                         (const :tag "Auto" auto)))))
1628
1629 (defcustom org-insert-heading-hook nil
1630   "Hook being run after inserting a new heading."
1631   :group 'org-edit-structure
1632   :type 'hook)
1633
1634 (defcustom org-enable-fixed-width-editor t
1635   "Non-nil means lines starting with \":\" are treated as fixed-width.
1636 This currently only means they are never auto-wrapped.
1637 When nil, such lines will be treated like ordinary lines."
1638   :group 'org-edit-structure
1639   :type 'boolean)
1640
1641 (defcustom org-goto-auto-isearch t
1642   "Non-nil means typing characters in `org-goto' starts incremental search.
1643 When nil, you can use these keybindings to navigate the buffer:
1644
1645   q    Quit the org-goto interface
1646   n    Go to the next visible heading
1647   p    Go to the previous visible heading
1648   f    Go one heading forward on same level
1649   b    Go one heading backward on same level
1650   u    Go one heading up"
1651   :group 'org-edit-structure
1652   :type 'boolean)
1653
1654 (defgroup org-sparse-trees nil
1655   "Options concerning sparse trees in Org-mode."
1656   :tag "Org Sparse Trees"
1657   :group 'org-structure)
1658
1659 (defcustom org-highlight-sparse-tree-matches t
1660   "Non-nil means highlight all matches that define a sparse tree.
1661 The highlights will automatically disappear the next time the buffer is
1662 changed by an edit command."
1663   :group 'org-sparse-trees
1664   :type 'boolean)
1665
1666 (defcustom org-remove-highlights-with-change t
1667   "Non-nil means any change to the buffer will remove temporary highlights.
1668 \\<org-mode-map>\
1669 Such highlights are created by `org-occur' and `org-clock-display'.
1670 When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
1671 to get rid of the highlights.
1672 The highlights created by `org-toggle-latex-fragment' always need
1673 `\\[org-toggle-latex-fragment]' to be removed."
1674   :group 'org-sparse-trees
1675   :group 'org-time
1676   :type 'boolean)
1677
1678
1679 (defcustom org-occur-hook '(org-first-headline-recenter)
1680   "Hook that is run after `org-occur' has constructed a sparse tree.
1681 This can be used to recenter the window to show as much of the structure
1682 as possible."
1683   :group 'org-sparse-trees
1684   :type 'hook)
1685
1686 (defgroup org-imenu-and-speedbar nil
1687   "Options concerning imenu and speedbar in Org-mode."
1688   :tag "Org Imenu and Speedbar"
1689   :group 'org-structure)
1690
1691 (defcustom org-imenu-depth 2
1692   "The maximum level for Imenu access to Org-mode headlines.
1693 This also applied for speedbar access."
1694   :group 'org-imenu-and-speedbar
1695   :type 'integer)
1696
1697 (defgroup org-table nil
1698   "Options concerning tables in Org-mode."
1699   :tag "Org Table"
1700   :group 'org)
1701
1702 (defcustom org-enable-table-editor 'optimized
1703   "Non-nil means lines starting with \"|\" are handled by the table editor.
1704 When nil, such lines will be treated like ordinary lines.
1705
1706 When equal to the symbol `optimized', the table editor will be optimized to
1707 do the following:
1708 - Automatic overwrite mode in front of whitespace in table fields.
1709   This makes the structure of the table stay in tact as long as the edited
1710   field does not exceed the column width.
1711 - Minimize the number of realigns.  Normally, the table is aligned each time
1712   TAB or RET are pressed to move to another field.  With optimization this
1713   happens only if changes to a field might have changed the column width.
1714 Optimization requires replacing the functions `self-insert-command',
1715 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1716 slight (in fact: unnoticeable) speed impact for normal typing.  Org-mode is
1717 very good at guessing when a re-align will be necessary, but you can always
1718 force one with \\[org-ctrl-c-ctrl-c].
1719
1720 If you would like to use the optimized version in Org-mode, but the
1721 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1722
1723 This variable can be used to turn on and off the table editor during a session,
1724 but in order to toggle optimization, a restart is required.
1725
1726 See also the variable `org-table-auto-blank-field'."
1727   :group 'org-table
1728   :type '(choice
1729           (const :tag "off" nil)
1730           (const :tag "on" t)
1731           (const :tag "on, optimized" optimized)))
1732
1733 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1734                                                 (version<= emacs-version "24.1"))
1735   "Non-nil means cluster self-insert commands for undo when possible.
1736 If this is set, then, like in the Emacs command loop, 20 consecutive
1737 characters will be undone together.
1738 This is configurable, because there is some impact on typing performance."
1739   :group 'org-table
1740   :type 'boolean)
1741
1742 (defcustom org-table-tab-recognizes-table.el t
1743   "Non-nil means TAB will automatically notice a table.el table.
1744 When it sees such a table, it moves point into it and - if necessary -
1745 calls `table-recognize-table'."
1746   :group 'org-table-editing
1747   :type 'boolean)
1748
1749 (defgroup org-link nil
1750   "Options concerning links in Org-mode."
1751   :tag "Org Link"
1752   :group 'org)
1753
1754 (defvar-local org-link-abbrev-alist-local nil
1755   "Buffer-local version of `org-link-abbrev-alist', which see.
1756 The value of this is taken from the #+LINK lines.")
1757
1758 (defcustom org-link-abbrev-alist nil
1759   "Alist of link abbreviations.
1760 The car of each element is a string, to be replaced at the start of a link.
1761 The cdrs are replacement values, like (\"linkkey\" . REPLACE).  Abbreviated
1762 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1763
1764      [[linkkey:tag][description]]
1765
1766 The `linkkey' must be a word word, starting with a letter, followed
1767 by letters, numbers, `-' or `_'.
1768
1769 If REPLACE is a string, the tag will simply be appended to create the link.
1770 If the string contains \"%s\", the tag will be inserted there.  If the string
1771 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1772 at that point (see the function `url-hexify-string').  If the string contains
1773 the specifier \"%(my-function)\", then the custom function `my-function' will
1774 be invoked: this function takes the tag as its only argument and must return
1775 a string.
1776
1777 REPLACE may also be a function that will be called with the tag as the
1778 only argument to create the link, which should be returned as a string.
1779
1780 See the manual for examples."
1781   :group 'org-link
1782   :type '(repeat
1783           (cons
1784            (string :tag "Protocol")
1785            (choice
1786             (string :tag "Format")
1787             (function)))))
1788
1789 (defcustom org-descriptive-links t
1790   "Non-nil means Org will display descriptive links.
1791 E.g. [[http://orgmode.org][Org website]] will be displayed as
1792 \"Org Website\", hiding the link itself and just displaying its
1793 description.  When set to nil, Org will display the full links
1794 literally.
1795
1796 You can interactively set the value of this variable by calling
1797 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1798   :group 'org-link
1799   :type 'boolean)
1800
1801 (defcustom org-link-file-path-type 'adaptive
1802   "How the path name in file links should be stored.
1803 Valid values are:
1804
1805 relative  Relative to the current directory, i.e. the directory of the file
1806           into which the link is being inserted.
1807 absolute  Absolute path, if possible with ~ for home directory.
1808 noabbrev  Absolute path, no abbreviation of home directory.
1809 adaptive  Use relative path for files in the current directory and sub-
1810           directories of it.  For other files, use an absolute path."
1811   :group 'org-link
1812   :type '(choice
1813           (const relative)
1814           (const absolute)
1815           (const noabbrev)
1816           (const adaptive)))
1817
1818 (defvaralias 'org-activate-links 'org-highlight-links)
1819 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1820   "Types of links that should be highlighted in Org-mode files.
1821
1822 This is a list of symbols, each one of them leading to the
1823 highlighting of a certain link type.
1824
1825 You can still open links that are not highlighted.
1826
1827 In principle, it does not hurt to turn on highlighting for all
1828 link types.  There may be a small gain when turning off unused
1829 link types.  The types are:
1830
1831 bracket   The recommended [[link][description]] or [[link]] links with hiding.
1832 angle     Links in angular brackets that may contain whitespace like
1833           <bbdb:Carsten Dominik>.
1834 plain     Plain links in normal text, no whitespace, like http://google.com.
1835 radio     Text that is matched by a radio target, see manual for details.
1836 tag       Tag settings in a headline (link to tag search).
1837 date      Time stamps (link to calendar).
1838 footnote  Footnote labels.
1839
1840 If you set this variable during an Emacs session, use `org-mode-restart'
1841 in the Org buffer so that the change takes effect."
1842   :group 'org-link
1843   :group 'org-appearance
1844   :type '(set :greedy t
1845               (const :tag "Double bracket links" bracket)
1846               (const :tag "Angular bracket links" angle)
1847               (const :tag "Plain text links" plain)
1848               (const :tag "Radio target matches" radio)
1849               (const :tag "Tags" tag)
1850               (const :tag "Timestamps" date)
1851               (const :tag "Footnotes" footnote)))
1852
1853 (defcustom org-make-link-description-function nil
1854   "Function to use for generating link descriptions from links.
1855 When nil, the link location will be used.  This function must take
1856 two parameters: the first one is the link, the second one is the
1857 description generated by `org-insert-link'.  The function should
1858 return the description to use."
1859   :group 'org-link
1860   :type '(choice (const nil) (function)))
1861
1862 (defgroup org-link-store nil
1863   "Options concerning storing links in Org-mode."
1864   :tag "Org Store Link"
1865   :group 'org-link)
1866
1867 (defcustom org-url-hexify-p t
1868   "When non-nil, hexify URL when creating a link."
1869   :type 'boolean
1870   :version "24.3"
1871   :group 'org-link-store)
1872
1873 (defcustom org-email-link-description-format "Email %c: %.30s"
1874   "Format of the description part of a link to an email or usenet message.
1875 The following %-escapes will be replaced by corresponding information:
1876
1877 %F   full \"From\" field
1878 %f   name, taken from \"From\" field, address if no name
1879 %T   full \"To\" field
1880 %t   first name in \"To\" field, address if no name
1881 %c   correspondent.  Usually \"from NAME\", but if you sent it yourself, it
1882      will be \"to NAME\".  See also the variable `org-from-is-user-regexp'.
1883 %s   subject
1884 %d   date
1885 %m   message-id.
1886
1887 You may use normal field width specification between the % and the letter.
1888 This is for example useful to limit the length of the subject.
1889
1890 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1891   :group 'org-link-store
1892   :type 'string)
1893
1894 (defcustom org-from-is-user-regexp
1895   (let (r1 r2)
1896     (when (and user-mail-address (not (string= user-mail-address "")))
1897       (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1898     (when (and user-full-name (not (string= user-full-name "")))
1899       (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1900     (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1901   "Regexp matched against the \"From:\" header of an email or usenet message.
1902 It should match if the message is from the user him/herself."
1903   :group 'org-link-store
1904   :type 'regexp)
1905
1906 (defcustom org-context-in-file-links t
1907   "Non-nil means file links from `org-store-link' contain context.
1908 A search string will be added to the file name with :: as separator and
1909 used to find the context when the link is activated by the command
1910 `org-open-at-point'.  When this option is t, the entire active region
1911 will be placed in the search string of the file link.  If set to a
1912 positive integer, only the first n lines of context will be stored.
1913
1914 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1915 negates this setting for the duration of the command."
1916   :group 'org-link-store
1917   :type '(choice boolean integer))
1918
1919 (defcustom org-keep-stored-link-after-insertion nil
1920   "Non-nil means keep link in list for entire session.
1921
1922 The command `org-store-link' adds a link pointing to the current
1923 location to an internal list.  These links accumulate during a session.
1924 The command `org-insert-link' can be used to insert links into any
1925 Org-mode file (offering completion for all stored links).  When this
1926 option is nil, every link which has been inserted once using \\[org-insert-link]
1927 will be removed from the list, to make completing the unused links
1928 more efficient."
1929   :group 'org-link-store
1930   :type 'boolean)
1931
1932 (defgroup org-link-follow nil
1933   "Options concerning following links in Org-mode."
1934   :tag "Org Follow Link"
1935   :group 'org-link)
1936
1937 (defcustom org-link-translation-function nil
1938   "Function to translate links with different syntax to Org syntax.
1939 This can be used to translate links created for example by the Planner
1940 or emacs-wiki packages to Org syntax.
1941 The function must accept two parameters, a TYPE containing the link
1942 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1943 which is everything after the link protocol.  It should return a cons
1944 with possibly modified values of type and path.
1945 Org contains a function for this, so if you set this variable to
1946 `org-translate-link-from-planner', you should be able follow many
1947 links created by planner."
1948   :group 'org-link-follow
1949   :type '(choice (const nil) (function)))
1950
1951 (defcustom org-follow-link-hook nil
1952   "Hook that is run after a link has been followed."
1953   :group 'org-link-follow
1954   :type 'hook)
1955
1956 (defcustom org-tab-follows-link nil
1957   "Non-nil means on links TAB will follow the link.
1958 Needs to be set before org.el is loaded.
1959 This really should not be used, it does not make sense, and the
1960 implementation is bad."
1961   :group 'org-link-follow
1962   :type 'boolean)
1963
1964 (defcustom org-return-follows-link nil
1965   "Non-nil means on links RET will follow the link.
1966 In tables, the special behavior of RET has precedence."
1967   :group 'org-link-follow
1968   :type 'boolean)
1969
1970 (defcustom org-mouse-1-follows-link
1971   (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1972   "Non-nil means mouse-1 on a link will follow the link.
1973 A longer mouse click will still set point.  Does not work on XEmacs.
1974 Needs to be set before org.el is loaded."
1975   :group 'org-link-follow
1976   :version "24.4"
1977   :package-version '(Org . "8.3")
1978   :type '(choice
1979           (const :tag "A double click follows the link" double)
1980           (const :tag "Unconditionally follow the link with mouse-1" t)
1981           (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1982
1983 (defcustom org-mark-ring-length 4
1984   "Number of different positions to be recorded in the ring.
1985 Changing this requires a restart of Emacs to work correctly."
1986   :group 'org-link-follow
1987   :type 'integer)
1988
1989 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1990   "Non-nil means internal links in Org files must exactly match a headline.
1991 When nil, the link search tries to match a phrase with all words
1992 in the search text."
1993   :group 'org-link-follow
1994   :version "24.1"
1995   :type '(choice
1996           (const :tag "Use fuzzy text search" nil)
1997           (const :tag "Match only exact headline" t)
1998           (const :tag "Match exact headline or query to create it"
1999                  query-to-create)))
2000
2001 (defcustom org-link-frame-setup
2002   '((vm . vm-visit-folder-other-frame)
2003     (vm-imap . vm-visit-imap-folder-other-frame)
2004     (gnus . org-gnus-no-new-news)
2005     (file . find-file-other-window)
2006     (wl . wl-other-frame))
2007   "Setup the frame configuration for following links.
2008 When following a link with Emacs, it may often be useful to display
2009 this link in another window or frame.  This variable can be used to
2010 set this up for the different types of links.
2011 For VM, use any of
2012     `vm-visit-folder'
2013     `vm-visit-folder-other-window'
2014     `vm-visit-folder-other-frame'
2015 For Gnus, use any of
2016     `gnus'
2017     `gnus-other-frame'
2018     `org-gnus-no-new-news'
2019 For FILE, use any of
2020     `find-file'
2021     `find-file-other-window'
2022     `find-file-other-frame'
2023 For Wanderlust use any of
2024     `wl'
2025     `wl-other-frame'
2026 For the calendar, use the variable `calendar-setup'.
2027 For BBDB, it is currently only possible to display the matches in
2028 another window."
2029   :group 'org-link-follow
2030   :type '(list
2031           (cons (const vm)
2032                 (choice
2033                  (const vm-visit-folder)
2034                  (const vm-visit-folder-other-window)
2035                  (const vm-visit-folder-other-frame)))
2036           (cons (const vm-imap)
2037                 (choice
2038                  (const vm-visit-imap-folder)
2039                  (const vm-visit-imap-folder-other-window)
2040                  (const vm-visit-imap-folder-other-frame)))
2041           (cons (const gnus)
2042                 (choice
2043                  (const gnus)
2044                  (const gnus-other-frame)
2045                  (const org-gnus-no-new-news)))
2046           (cons (const file)
2047                 (choice
2048                  (const find-file)
2049                  (const find-file-other-window)
2050                  (const find-file-other-frame)))
2051           (cons (const wl)
2052                 (choice
2053                  (const wl)
2054                  (const wl-other-frame)))))
2055
2056 (defcustom org-display-internal-link-with-indirect-buffer nil
2057   "Non-nil means use indirect buffer to display infile links.
2058 Activating internal links (from one location in a file to another location
2059 in the same file) normally just jumps to the location.  When the link is
2060 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2061 is displayed in
2062 another window.  When this option is set, the other window actually displays
2063 an indirect buffer clone of the current buffer, to avoid any visibility
2064 changes to the current buffer."
2065   :group 'org-link-follow
2066   :type 'boolean)
2067
2068 (defcustom org-open-non-existing-files nil
2069   "Non-nil means `org-open-file' will open non-existing files.
2070 When nil, an error will be generated.
2071 This variable applies only to external applications because they
2072 might choke on non-existing files.  If the link is to a file that
2073 will be opened in Emacs, the variable is ignored."
2074   :group 'org-link-follow
2075   :type 'boolean)
2076
2077 (defcustom org-open-directory-means-index-dot-org nil
2078   "Non-nil means a link to a directory really means to index.org.
2079 When nil, following a directory link will run dired or open a finder/explorer
2080 window on that directory."
2081   :group 'org-link-follow
2082   :type 'boolean)
2083
2084 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2085   "Non-nil means ask for confirmation before executing shell links.
2086 Shell links can be dangerous: just think about a link
2087
2088      [[shell:rm -rf ~/*][Google Search]]
2089
2090 This link would show up in your Org-mode document as \"Google Search\",
2091 but really it would remove your entire home directory.
2092 Therefore we advise against setting this variable to nil.
2093 Just change it to `y-or-n-p' if you want to confirm with a
2094 single keystroke rather than having to type \"yes\"."
2095   :group 'org-link-follow
2096   :type '(choice
2097           (const :tag "with yes-or-no (safer)" yes-or-no-p)
2098           (const :tag "with y-or-n (faster)" y-or-n-p)
2099           (const :tag "no confirmation (dangerous)" nil)))
2100 (put 'org-confirm-shell-link-function
2101      'safe-local-variable
2102      (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2103
2104 (defcustom org-confirm-shell-link-not-regexp ""
2105   "A regexp to skip confirmation for shell links."
2106   :group 'org-link-follow
2107   :version "24.1"
2108   :type 'regexp)
2109
2110 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2111   "Non-nil means ask for confirmation before executing Emacs Lisp links.
2112 Elisp links can be dangerous: just think about a link
2113
2114      [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2115
2116 This link would show up in your Org-mode document as \"Google Search\",
2117 but really it would remove your entire home directory.
2118 Therefore we advise against setting this variable to nil.
2119 Just change it to `y-or-n-p' if you want to confirm with a
2120 single keystroke rather than having to type \"yes\"."
2121   :group 'org-link-follow
2122   :type '(choice
2123           (const :tag "with yes-or-no (safer)" yes-or-no-p)
2124           (const :tag "with y-or-n (faster)" y-or-n-p)
2125           (const :tag "no confirmation (dangerous)" nil)))
2126 (put 'org-confirm-shell-link-function
2127      'safe-local-variable
2128      (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2129
2130 (defcustom org-confirm-elisp-link-not-regexp ""
2131   "A regexp to skip confirmation for Elisp links."
2132   :group 'org-link-follow
2133   :version "24.1"
2134   :type 'regexp)
2135
2136 (defconst org-file-apps-defaults-gnu
2137   '((remote . emacs)
2138     (system . mailcap)
2139     (t . mailcap))
2140   "Default file applications on a UNIX or GNU/Linux system.
2141 See `org-file-apps'.")
2142
2143 (defconst org-file-apps-defaults-macosx
2144   '((remote . emacs)
2145     (system . "open %s")
2146     ("ps.gz"  . "gv %s")
2147     ("eps.gz" . "gv %s")
2148     ("dvi"    . "xdvi %s")
2149     ("fig"    . "xfig %s")
2150     (t . "open %s"))
2151   "Default file applications on a MacOS X system.
2152 The system \"open\" is known as a default, but we use X11 applications
2153 for some files for which the OS does not have a good default.
2154 See `org-file-apps'.")
2155
2156 (defconst org-file-apps-defaults-windowsnt
2157   (list '(remote . emacs)
2158         (cons 'system (lambda (file _path)
2159                         (with-no-warnings (w32-shell-execute "open" file))))
2160         (cons t (lambda (file _path)
2161                   (with-no-warnings (w32-shell-execute "open" file)))))
2162   "Default file applications on a Windows NT system.
2163 The system \"open\" is used for most files.
2164 See `org-file-apps'.")
2165
2166 (defcustom org-file-apps
2167   '((auto-mode . emacs)
2168     ("\\.mm\\'" . default)
2169     ("\\.x?html?\\'" . default)
2170     ("\\.pdf\\'" . default))
2171   "External applications for opening `file:path' items in a document.
2172 \\<org-mode-map>\
2173 Org mode uses system defaults for different file types, but
2174 you can use this variable to set the application for a given file
2175 extension.  The entries in this list are cons cells where the car identifies
2176 files and the cdr the corresponding command.  Possible values for the
2177 file identifier are
2178  \"string\"    A string as a file identifier can be interpreted in different
2179                ways, depending on its contents:
2180
2181                - Alphanumeric characters only:
2182                  Match links with this file extension.
2183                  Example: (\"pdf\" . \"evince %s\")
2184                           to open PDFs with evince.
2185
2186                - Regular expression: Match links where the
2187                  filename matches the regexp.  If you want to
2188                  use groups here, use shy groups.
2189
2190                  Example: (\"\\.x?html\\\\='\" . \"firefox %s\")
2191                           \(\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2192                           to open *.html and *.xhtml with firefox.
2193
2194                - Regular expression which contains (non-shy) groups:
2195                  Match links where the whole link, including \"::\", and
2196                  anything after that, matches the regexp.
2197                  In a custom command string, %1, %2, etc. are replaced with
2198                  the parts of the link that were matched by the groups.
2199                  For backwards compatibility, if a command string is given
2200                  that does not use any of the group matches, this case is
2201                  handled identically to the second one (i.e. match against
2202                  file name only).
2203                  In a custom function, you can access the group matches with
2204                  \(match-string n link).
2205
2206                  Example: (\"\\.pdf::\\(\\d+\\)\\\\='\" . \"evince -p %1 %s\")
2207                      to open [[file:document.pdf::5]] with evince at page 5.
2208
2209  `directory'   Matches a directory
2210  `remote'      Matches a remote file, accessible through tramp or efs.
2211                Remote files most likely should be visited through Emacs
2212                because external applications cannot handle such paths.
2213 `auto-mode'    Matches files that are matched by any entry in `auto-mode-alist',
2214                so all files Emacs knows how to handle.  Using this with
2215                command `emacs' will open most files in Emacs.  Beware that this
2216                will also open html files inside Emacs, unless you add
2217                \(\"html\" . default) to the list as well.
2218  `system'      The system command to open files, like `open' on Windows
2219                and Mac OS X, and mailcap under GNU/Linux.  This is the command
2220                that will be selected if you call \\[org-open-at-point] with a double
2221                \\[universal-argument] \\[universal-argument] prefix.
2222  t             Default for files not matched by any of the other options.
2223
2224 Possible values for the command are:
2225  `emacs'       The file will be visited by the current Emacs process.
2226  `default'     Use the default application for this file type, which is the
2227                association for t in the list, most likely in the system-specific
2228                part.  This can be used to overrule an unwanted setting in the
2229                system-specific variable.
2230  `system'      Use the system command for opening files, like \"open\".
2231                This command is specified by the entry whose car is `system'.
2232                Most likely, the system-specific version of this variable
2233                does define this command, but you can overrule/replace it
2234                here.
2235 `mailcap'      Use command specified in the mailcaps.
2236  string        A command to be executed by a shell; %s will be replaced
2237                by the path to the file.
2238
2239  function      A Lisp function, which will be called with two arguments:
2240                the file path and the original link string, without the
2241                \"file:\" prefix.
2242
2243 For more examples, see the system specific constants
2244 `org-file-apps-defaults-macosx'
2245 `org-file-apps-defaults-windowsnt'
2246 `org-file-apps-defaults-gnu'."
2247   :group 'org-link-follow
2248   :type '(repeat
2249           (cons (choice :value ""
2250                         (string :tag "Extension")
2251                         (const :tag "System command to open files" system)
2252                         (const :tag "Default for unrecognized files" t)
2253                         (const :tag "Remote file" remote)
2254                         (const :tag "Links to a directory" directory)
2255                         (const :tag "Any files that have Emacs modes"
2256                                auto-mode))
2257                 (choice :value ""
2258                         (const :tag "Visit with Emacs" emacs)
2259                         (const :tag "Use default" default)
2260                         (const :tag "Use the system command" system)
2261                         (string :tag "Command")
2262                         (function :tag "Function")))))
2263
2264 (defcustom org-doi-server-url "http://dx.doi.org/"
2265   "The URL of the DOI server."
2266   :type 'string
2267   :version "24.3"
2268   :group 'org-link-follow)
2269
2270 (defgroup org-refile nil
2271   "Options concerning refiling entries in Org-mode."
2272   :tag "Org Refile"
2273   :group 'org)
2274
2275 (defcustom org-directory "~/org"
2276   "Directory with Org files.
2277 This is just a default location to look for Org files.  There is no need
2278 at all to put your files into this directory.  It is used in the
2279 following situations:
2280
2281 1. When a capture template specifies a target file that is not an
2282    absolute path.  The path will then be interpreted relative to
2283    `org-directory'
2284 2. When the value of variable `org-agenda-files' is a single file, any
2285    relative paths in this file will be taken as relative to
2286    `org-directory'."
2287   :group 'org-refile
2288   :group 'org-capture
2289   :type 'directory)
2290
2291 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2292   "Default target for storing notes.
2293 Used as a fall back file for org-capture.el, for templates that
2294 do not specify a target file."
2295   :group 'org-refile
2296   :group 'org-capture
2297   :type 'file)
2298
2299 (defcustom org-goto-interface 'outline
2300   "The default interface to be used for `org-goto'.
2301 Allowed values are:
2302 outline                  The interface shows an outline of the relevant file
2303                          and the correct heading is found by moving through
2304                          the outline or by searching with incremental search.
2305 outline-path-completion  Headlines in the current buffer are offered via
2306                          completion.  This is the interface also used by
2307                          the refile command."
2308   :group 'org-refile
2309   :type '(choice
2310           (const :tag "Outline" outline)
2311           (const :tag "Outline-path-completion" outline-path-completion)))
2312
2313 (defcustom org-goto-max-level 5
2314   "Maximum target level when running `org-goto' with refile interface."
2315   :group 'org-refile
2316   :type 'integer)
2317
2318 (defcustom org-reverse-note-order nil
2319   "Non-nil means store new notes at the beginning of a file or entry.
2320 When nil, new notes will be filed to the end of a file or entry.
2321 This can also be a list with cons cells of regular expressions that
2322 are matched against file names, and values."
2323   :group 'org-capture
2324   :group 'org-refile
2325   :type '(choice
2326           (const :tag "Reverse always" t)
2327           (const :tag "Reverse never" nil)
2328           (repeat :tag "By file name regexp"
2329                   (cons regexp boolean))))
2330
2331 (defcustom org-log-refile nil
2332   "Information to record when a task is refiled.
2333
2334 Possible values are:
2335
2336 nil     Don't add anything
2337 time    Add a time stamp to the task
2338 note    Prompt for a note and add it with template `org-log-note-headings'
2339
2340 This option can also be set with on a per-file-basis with
2341
2342    #+STARTUP: nologrefile
2343    #+STARTUP: logrefile
2344    #+STARTUP: lognoterefile
2345
2346 You can have local logging settings for a subtree by setting the LOGGING
2347 property to one or more of these keywords.
2348
2349 When bulk-refiling from the agenda, the value `note' is forbidden and
2350 will temporarily be changed to `time'."
2351   :group 'org-refile
2352   :group 'org-progress
2353   :version "24.1"
2354   :type '(choice
2355           (const :tag "No logging" nil)
2356           (const :tag "Record timestamp" time)
2357           (const :tag "Record timestamp with note." note)))
2358
2359 (defcustom org-refile-targets nil
2360   "Targets for refiling entries with \\[org-refile].
2361 This is a list of cons cells.  Each cell contains:
2362 - a specification of the files to be considered, either a list of files,
2363   or a symbol whose function or variable value will be used to retrieve
2364   a file name or a list of file names.  If you use `org-agenda-files' for
2365   that, all agenda files will be scanned for targets.  Nil means consider
2366   headings in the current buffer.
2367 - A specification of how to find candidate refile targets.  This may be
2368   any of:
2369   - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2370     This tag has to be present in all target headlines, inheritance will
2371     not be considered.
2372   - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2373     todo keyword.
2374   - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2375     headlines that are refiling targets.
2376   - a cons cell (:level . N).  Any headline of level N is considered a target.
2377     Note that, when `org-odd-levels-only' is set, level corresponds to
2378     order in hierarchy, not to the number of stars.
2379   - a cons cell (:maxlevel . N).  Any headline with level <= N is a target.
2380     Note that, when `org-odd-levels-only' is set, level corresponds to
2381     order in hierarchy, not to the number of stars.
2382
2383 Each element of this list generates a set of possible targets.
2384 The union of these sets is presented (with completion) to
2385 the user by `org-refile'.
2386
2387 You can set the variable `org-refile-target-verify-function' to a function
2388 to verify each headline found by the simple criteria above.
2389
2390 When this variable is nil, all top-level headlines in the current buffer
2391 are used, equivalent to the value `((nil . (:level . 1))'."
2392   :group 'org-refile
2393   :type '(repeat
2394           (cons
2395            (choice :value org-agenda-files
2396                    (const :tag "All agenda files" org-agenda-files)
2397                    (const :tag "Current buffer" nil)
2398                    (function) (variable) (file))
2399            (choice :tag "Identify target headline by"
2400                    (cons :tag "Specific tag" (const :value :tag) (string))
2401                    (cons :tag "TODO keyword" (const :value :todo) (string))
2402                    (cons :tag "Regular expression" (const :value :regexp) (regexp))
2403                    (cons :tag "Level number" (const :value :level) (integer))
2404                    (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2405
2406 (defcustom org-refile-target-verify-function nil
2407   "Function to verify if the headline at point should be a refile target.
2408 The function will be called without arguments, with point at the
2409 beginning of the headline.  It should return t and leave point
2410 where it is if the headline is a valid target for refiling.
2411
2412 If the target should not be selected, the function must return nil.
2413 In addition to this, it may move point to a place from where the search
2414 should be continued.  For example, the function may decide that the entire
2415 subtree of the current entry should be excluded and move point to the end
2416 of the subtree."
2417   :group 'org-refile
2418   :type '(choice
2419           (const nil)
2420           (function)))
2421
2422 (defcustom org-refile-use-cache nil
2423   "Non-nil means cache refile targets to speed up the process.
2424 \\<org-mode-map>\
2425 The cache for a particular file will be updated automatically when
2426 the buffer has been killed, or when any of the marker used for flagging
2427 refile targets no longer points at a live buffer.
2428 If you have added new entries to a buffer that might themselves be targets,
2429 you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
2430 if you find that easier, \
2431 `\\[universal-argument] \\[universal-argument] \\[universal-argument] \
2432 \\[org-refile]'."
2433   :group 'org-refile
2434   :version "24.1"
2435   :type 'boolean)
2436
2437 (defcustom org-refile-use-outline-path nil
2438   "Non-nil means provide refile targets as paths.
2439 So a level 3 headline will be available as level1/level2/level3.
2440
2441 When the value is `file', also include the file name (without directory)
2442 into the path.  In this case, you can also stop the completion after
2443 the file name, to get entries inserted as top level in the file.
2444
2445 When `full-file-path', include the full file path."
2446   :group 'org-refile
2447   :type '(choice
2448           (const :tag "Not" nil)
2449           (const :tag "Yes" t)
2450           (const :tag "Start with file name" file)
2451           (const :tag "Start with full file path" full-file-path)))
2452
2453 (defcustom org-outline-path-complete-in-steps t
2454   "Non-nil means complete the outline path in hierarchical steps.
2455 When Org-mode uses the refile interface to select an outline path
2456 \(see variable `org-refile-use-outline-path'), the completion of
2457 the path can be done in a single go, or it can be done in steps down
2458 the headline hierarchy.  Going in steps is probably the best if you
2459 do not use a special completion package like `ido' or `icicles'.
2460 However, when using these packages, going in one step can be very
2461 fast, while still showing the whole path to the entry."
2462   :group 'org-refile
2463   :type 'boolean)
2464
2465 (defcustom org-refile-allow-creating-parent-nodes nil
2466   "Non-nil means allow the creation of new nodes as refile targets.
2467 New nodes are then created by adding \"/new node name\" to the completion
2468 of an existing node.  When the value of this variable is `confirm',
2469 new node creation must be confirmed by the user (recommended).
2470 When nil, the completion must match an existing entry.
2471
2472 Note that, if the new heading is not seen by the criteria
2473 listed in `org-refile-targets', multiple instances of the same
2474 heading would be created by trying again to file under the new
2475 heading."
2476   :group 'org-refile
2477   :type '(choice
2478           (const :tag "Never" nil)
2479           (const :tag "Always" t)
2480           (const :tag "Prompt for confirmation" confirm)))
2481
2482 (defcustom org-refile-active-region-within-subtree nil
2483   "Non-nil means also refile active region within a subtree.
2484
2485 By default `org-refile' doesn't allow refiling regions if they
2486 don't contain a set of subtrees, but it might be convenient to
2487 do so sometimes: in that case, the first line of the region is
2488 converted to a headline before refiling."
2489   :group 'org-refile
2490   :version "24.1"
2491   :type 'boolean)
2492
2493 (defgroup org-todo nil
2494   "Options concerning TODO items in Org-mode."
2495   :tag "Org TODO"
2496   :group 'org)
2497
2498 (defgroup org-progress nil
2499   "Options concerning Progress logging in Org-mode."
2500   :tag "Org Progress"
2501   :group 'org-time)
2502
2503 (defvar org-todo-interpretation-widgets
2504   '((:tag "Sequence (cycling hits every state)" sequence)
2505     (:tag "Type     (cycling directly to DONE)" type))
2506   "The available interpretation symbols for customizing `org-todo-keywords'.
2507 Interested libraries should add to this list.")
2508
2509 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2510   "List of TODO entry keyword sequences and their interpretation.
2511 \\<org-mode-map>This is a list of sequences.
2512
2513 Each sequence starts with a symbol, either `sequence' or `type',
2514 indicating if the keywords should be interpreted as a sequence of
2515 action steps, or as different types of TODO items.  The first
2516 keywords are states requiring action - these states will select a headline
2517 for inclusion into the global TODO list Org-mode produces.  If one of
2518 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2519 signify that no further action is necessary.  If \"|\" is not found,
2520 the last keyword is treated as the only DONE state of the sequence.
2521
2522 The command \\[org-todo] cycles an entry through these states, and one
2523 additional state where no keyword is present.  For details about this
2524 cycling, see the manual.
2525
2526 TODO keywords and interpretation can also be set on a per-file basis with
2527 the special #+SEQ_TODO and #+TYP_TODO lines.
2528
2529 Each keyword can optionally specify a character for fast state selection
2530 \(in combination with the variable `org-use-fast-todo-selection')
2531 and specifiers for state change logging, using the same syntax that
2532 is used in the \"#+TODO:\" lines.  For example, \"WAIT(w)\" says that
2533 the WAIT state can be selected with the \"w\" key.  \"WAIT(w!)\"
2534 indicates to record a time stamp each time this state is selected.
2535
2536 Each keyword may also specify if a timestamp or a note should be
2537 recorded when entering or leaving the state, by adding additional
2538 characters in the parenthesis after the keyword.  This looks like this:
2539 \"WAIT(w@/!)\".  \"@\" means to add a note (with time), \"!\" means to
2540 record only the time of the state change.  With X and Y being either
2541 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2542 Y when leaving the state if and only if the *target* state does not
2543 define X.  You may omit any of the fast-selection key or X or /Y,
2544 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2545
2546 For backward compatibility, this variable may also be just a list
2547 of keywords.  In this case the interpretation (sequence or type) will be
2548 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2549   :group 'org-todo
2550   :group 'org-keywords
2551   :type '(choice
2552           (repeat :tag "Old syntax, just keywords"
2553                   (string :tag "Keyword"))
2554           (repeat :tag "New syntax"
2555                   (cons
2556                    (choice
2557                     :tag "Interpretation"
2558                     ;;Quick and dirty way to see
2559                     ;;`org-todo-interpretations'.  This takes the
2560                     ;;place of item arguments
2561                     :convert-widget
2562                     (lambda (widget)
2563                       (widget-put widget
2564                                   :args (mapcar
2565                                          (lambda (x)
2566                                            (widget-convert
2567                                             (cons 'const x)))
2568                                          org-todo-interpretation-widgets))
2569                       widget))
2570                    (repeat
2571                     (string :tag "Keyword"))))))
2572
2573 (defvar-local org-todo-keywords-1 nil
2574   "All TODO and DONE keywords active in a buffer.")
2575 (defvar org-todo-keywords-for-agenda nil)
2576 (defvar org-done-keywords-for-agenda nil)
2577 (defvar org-todo-keyword-alist-for-agenda nil)
2578 (defvar org-tag-alist-for-agenda nil
2579   "Alist of all tags from all agenda files.")
2580 (defvar org-tag-groups-alist-for-agenda nil
2581   "Alist of all groups tags from all current agenda files.")
2582 (defvar-local org-tag-groups-alist nil)
2583 (defvar org-agenda-contributing-files nil)
2584 (defvar-local org-not-done-keywords nil)
2585 (defvar-local org-done-keywords nil)
2586 (defvar-local org-todo-heads nil)
2587 (defvar-local org-todo-sets nil)
2588 (defvar-local org-todo-log-states nil)
2589 (defvar-local org-todo-kwd-alist nil)
2590 (defvar-local org-todo-key-alist nil)
2591 (defvar-local org-todo-key-trigger nil)
2592
2593 (defcustom org-todo-interpretation 'sequence
2594   "Controls how TODO keywords are interpreted.
2595 This variable is in principle obsolete and is only used for
2596 backward compatibility, if the interpretation of todo keywords is
2597 not given already in `org-todo-keywords'.  See that variable for
2598 more information."
2599   :group 'org-todo
2600   :group 'org-keywords
2601   :type '(choice (const sequence)
2602                  (const type)))
2603
2604 (defcustom org-use-fast-todo-selection t
2605   "\\<org-mode-map>\
2606 Non-nil means use the fast todo selection scheme with \\[org-todo].
2607 This variable describes if and under what circumstances the cycling
2608 mechanism for TODO keywords will be replaced by a single-key, direct
2609 selection scheme.
2610
2611 When nil, fast selection is never used.
2612
2613 When the symbol `prefix', it will be used when `org-todo' is called
2614 with a prefix argument,  i.e. `\\[universal-argument] \\[org-todo]' \
2615 in an Org-mode buffer, and
2616 `\\[universal-argument] t' in an agenda buffer.
2617
2618 When t, fast selection is used by default.  In this case, the prefix
2619 argument forces cycling instead.
2620
2621 In all cases, the special interface is only used if access keys have
2622 actually been assigned by the user, i.e. if keywords in the configuration
2623 are followed by a letter in parenthesis, like TODO(t)."
2624   :group 'org-todo
2625   :type '(choice
2626           (const :tag "Never" nil)
2627           (const :tag "By default" t)
2628           (const :tag "Only with C-u C-c C-t" prefix)))
2629
2630 (defcustom org-provide-todo-statistics t
2631   "Non-nil means update todo statistics after insert and toggle.
2632 ALL-HEADLINES means update todo statistics by including headlines
2633 with no TODO keyword as well, counting them as not done.
2634 A list of TODO keywords means the same, but skip keywords that are
2635 not in this list.
2636 When set to a list of two lists, the first list contains keywords
2637 to consider as TODO keywords, the second list contains keywords
2638 to consider as DONE keywords.
2639
2640 When this is set, todo statistics is updated in the parent of the
2641 current entry each time a todo state is changed."
2642   :group 'org-todo
2643   :type '(choice
2644           (const :tag "Yes, only for TODO entries" t)
2645           (const :tag "Yes, including all entries" all-headlines)
2646           (repeat :tag "Yes, for TODOs in this list"
2647                   (string :tag "TODO keyword"))
2648           (list :tag "Yes, for TODOs and DONEs in these lists"
2649                 (repeat (string :tag "TODO keyword"))
2650                 (repeat (string :tag "DONE keyword")))
2651           (other :tag "No TODO statistics" nil)))
2652
2653 (defcustom org-hierarchical-todo-statistics t
2654   "Non-nil means TODO statistics covers just direct children.
2655 When nil, all entries in the subtree are considered.
2656 This has only an effect if `org-provide-todo-statistics' is set.
2657 To set this to nil for only a single subtree, use a COOKIE_DATA
2658 property and include the word \"recursive\" into the value."
2659   :group 'org-todo
2660   :type 'boolean)
2661
2662 (defcustom org-after-todo-state-change-hook nil
2663   "Hook which is run after the state of a TODO item was changed.
2664 The new state (a string with a TODO keyword, or nil) is available in the
2665 Lisp variable `org-state'."
2666   :group 'org-todo
2667   :type 'hook)
2668
2669 (defvar org-blocker-hook nil
2670   "Hook for functions that are allowed to block a state change.
2671
2672 Functions in this hook should not modify the buffer.
2673 Each function gets as its single argument a property list,
2674 see `org-trigger-hook' for more information about this list.
2675
2676 If any of the functions in this hook returns nil, the state change
2677 is blocked.")
2678
2679 (defvar org-trigger-hook nil
2680   "Hook for functions that are triggered by a state change.
2681
2682 Each function gets as its single argument a property list with at
2683 least the following elements:
2684
2685  (:type type-of-change :position pos-at-entry-start
2686   :from old-state :to new-state)
2687
2688 Depending on the type, more properties may be present.
2689
2690 This mechanism is currently implemented for:
2691
2692 TODO state changes
2693 ------------------
2694 :type  todo-state-change
2695 :from  previous state (keyword as a string), or nil, or a symbol
2696        `todo' or `done', to indicate the general type of state.
2697 :to    new state, like in :from")
2698
2699 (defcustom org-enforce-todo-dependencies nil
2700   "Non-nil means undone TODO entries will block switching the parent to DONE.
2701 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2702 be blocked if any prior sibling is not yet done.
2703 Finally, if the parent is blocked because of ordered siblings of its own,
2704 the child will also be blocked."
2705   :set (lambda (var val)
2706          (set var val)
2707          (if val
2708              (add-hook 'org-blocker-hook
2709                        'org-block-todo-from-children-or-siblings-or-parent)
2710            (remove-hook 'org-blocker-hook
2711                         'org-block-todo-from-children-or-siblings-or-parent)))
2712   :group 'org-todo
2713   :type 'boolean)
2714
2715 (defcustom org-enforce-todo-checkbox-dependencies nil
2716   "Non-nil means unchecked boxes will block switching the parent to DONE.
2717 When this is nil, checkboxes have no influence on switching TODO states.
2718 When non-nil, you first need to check off all check boxes before the TODO
2719 entry can be switched to DONE.
2720 This variable needs to be set before org.el is loaded, and you need to
2721 restart Emacs after a change to make the change effective.  The only way
2722 to change is while Emacs is running is through the customize interface."
2723   :set (lambda (var val)
2724          (set var val)
2725          (if val
2726              (add-hook 'org-blocker-hook
2727                        'org-block-todo-from-checkboxes)
2728            (remove-hook 'org-blocker-hook
2729                         'org-block-todo-from-checkboxes)))
2730   :group 'org-todo
2731   :type 'boolean)
2732
2733 (defcustom org-treat-insert-todo-heading-as-state-change nil
2734   "Non-nil means inserting a TODO heading is treated as state change.
2735 So when the command \\[org-insert-todo-heading] is used, state change
2736 logging will apply if appropriate.  When nil, the new TODO item will
2737 be inserted directly, and no logging will take place."
2738   :group 'org-todo
2739   :type 'boolean)
2740
2741 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2742   "Non-nil means switching TODO states with S-cursor counts as state change.
2743 This is the default behavior.  However, setting this to nil allows a
2744 convenient way to select a TODO state and bypass any logging associated
2745 with that."
2746   :group 'org-todo
2747   :type 'boolean)
2748
2749 (defcustom org-todo-state-tags-triggers nil
2750   "Tag changes that should be triggered by TODO state changes.
2751 This is a list.  Each entry is
2752
2753   (state-change (tag . flag) .......)
2754
2755 State-change can be a string with a state, and empty string to indicate the
2756 state that has no TODO keyword, or it can be one of the symbols `todo'
2757 or `done', meaning any not-done or done state, respectively."
2758   :group 'org-todo
2759   :group 'org-tags
2760   :type '(repeat
2761           (cons (choice :tag "When changing to"
2762                         (const :tag "Not-done state" todo)
2763                         (const :tag "Done state" done)
2764                         (string :tag "State"))
2765                 (repeat
2766                  (cons :tag "Tag action"
2767                        (string :tag "Tag")
2768                        (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2769
2770 (defcustom org-log-done nil
2771   "Information to record when a task moves to the DONE state.
2772
2773 Possible values are:
2774
2775 nil     Don't add anything, just change the keyword
2776 time    Add a time stamp to the task
2777 note    Prompt for a note and add it with template `org-log-note-headings'
2778
2779 This option can also be set with on a per-file-basis with
2780
2781    #+STARTUP: nologdone
2782    #+STARTUP: logdone
2783    #+STARTUP: lognotedone
2784
2785 You can have local logging settings for a subtree by setting the LOGGING
2786 property to one or more of these keywords."
2787   :group 'org-todo
2788   :group 'org-progress
2789   :type '(choice
2790           (const :tag "No logging" nil)
2791           (const :tag "Record CLOSED timestamp" time)
2792           (const :tag "Record CLOSED timestamp with note." note)))
2793
2794 ;; Normalize old uses of org-log-done.
2795 (cond
2796  ((eq org-log-done t) (setq org-log-done 'time))
2797  ((and (listp org-log-done) (memq 'done org-log-done))
2798   (setq org-log-done 'note)))
2799
2800 (defcustom org-log-reschedule nil
2801   "Information to record when the scheduling date of a tasks is modified.
2802
2803 Possible values are:
2804
2805 nil     Don't add anything, just change the date
2806 time    Add a time stamp to the task
2807 note    Prompt for a note and add it with template `org-log-note-headings'
2808
2809 This option can also be set with on a per-file-basis with
2810
2811    #+STARTUP: nologreschedule
2812    #+STARTUP: logreschedule
2813    #+STARTUP: lognotereschedule"
2814   :group 'org-todo
2815   :group 'org-progress
2816   :type '(choice
2817           (const :tag "No logging" nil)
2818           (const :tag "Record timestamp" time)
2819           (const :tag "Record timestamp with note." note)))
2820
2821 (defcustom org-log-redeadline nil
2822   "Information to record when the deadline date of a tasks is modified.
2823
2824 Possible values are:
2825
2826 nil     Don't add anything, just change the date
2827 time    Add a time stamp to the task
2828 note    Prompt for a note and add it with template `org-log-note-headings'
2829
2830 This option can also be set with on a per-file-basis with
2831
2832    #+STARTUP: nologredeadline
2833    #+STARTUP: logredeadline
2834    #+STARTUP: lognoteredeadline
2835
2836 You can have local logging settings for a subtree by setting the LOGGING
2837 property to one or more of these keywords."
2838   :group 'org-todo
2839   :group 'org-progress
2840   :type '(choice
2841           (const :tag "No logging" nil)
2842           (const :tag "Record timestamp" time)
2843           (const :tag "Record timestamp with note." note)))
2844
2845 (defcustom org-log-note-clock-out nil
2846   "Non-nil means record a note when clocking out of an item.
2847 This can also be configured on a per-file basis by adding one of
2848 the following lines anywhere in the buffer:
2849
2850    #+STARTUP: lognoteclock-out
2851    #+STARTUP: nolognoteclock-out"
2852   :group 'org-todo
2853   :group 'org-progress
2854   :type 'boolean)
2855
2856 (defcustom org-log-done-with-time t
2857   "Non-nil means the CLOSED time stamp will contain date and time.
2858 When nil, only the date will be recorded."
2859   :group 'org-progress
2860   :type 'boolean)
2861
2862 (defcustom org-log-note-headings
2863   '((done .  "CLOSING NOTE %t")
2864     (state . "State %-12s from %-12S %t")
2865     (note .  "Note taken on %t")
2866     (reschedule .  "Rescheduled from %S on %t")
2867     (delschedule .  "Not scheduled, was %S on %t")
2868     (redeadline .  "New deadline from %S on %t")
2869     (deldeadline .  "Removed deadline, was %S on %t")
2870     (refile . "Refiled on %t")
2871     (clock-out . ""))
2872   "Headings for notes added to entries.
2873
2874 The value is an alist, with the car being a symbol indicating the
2875 note context, and the cdr is the heading to be used.  The heading
2876 may also be the empty string.  The following placeholders can be
2877 used:
2878
2879   %t  a time stamp.
2880   %T  an active time stamp instead the default inactive one
2881   %d  a short-format time stamp.
2882   %D  an active short-format time stamp.
2883   %s  the new TODO state or time stamp (inactive), in double quotes.
2884   %S  the old TODO state or time stamp (inactive), in double quotes.
2885   %u  the user name.
2886   %U  full user name.
2887
2888 In fact, it is not a good idea to change the `state' entry,
2889 because Agenda Log mode depends on the format of these entries."
2890   :group  'org-todo
2891   :group  'org-progress
2892   :type '(list :greedy t
2893                (cons (const :tag "Heading when closing an item" done) string)
2894                (cons (const :tag
2895                             "Heading when changing todo state (todo sequence only)"
2896                             state) string)
2897                (cons (const :tag "Heading when just taking a note" note) string)
2898                (cons (const :tag "Heading when rescheduling" reschedule) string)
2899                (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2900                (cons (const :tag "Heading when changing deadline"  redeadline) string)
2901                (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2902                (cons (const :tag "Heading when refiling" refile) string)
2903                (cons (const :tag "Heading when clocking out" clock-out) string)))
2904
2905 (unless (assq 'note org-log-note-headings)
2906   (push '(note . "%t") org-log-note-headings))
2907
2908 (defcustom org-log-into-drawer nil
2909   "Non-nil means insert state change notes and time stamps into a drawer.
2910 When nil, state changes notes will be inserted after the headline and
2911 any scheduling and clock lines, but not inside a drawer.
2912
2913 The value of this variable should be the name of the drawer to use.
2914 LOGBOOK is proposed as the default drawer for this purpose, you can
2915 also set this to a string to define the drawer of your choice.
2916
2917 A value of t is also allowed, representing \"LOGBOOK\".
2918
2919 A value of t or nil can also be set with on a per-file-basis with
2920
2921    #+STARTUP: logdrawer
2922    #+STARTUP: nologdrawer
2923
2924 If this variable is set, `org-log-state-notes-insert-after-drawers'
2925 will be ignored.
2926
2927 You can set the property LOG_INTO_DRAWER to overrule this setting for
2928 a subtree.
2929
2930 Do not check directly this variable in a Lisp program.  Call
2931 function `org-log-into-drawer' instead."
2932   :group 'org-todo
2933   :group 'org-progress
2934   :type '(choice
2935           (const :tag "Not into a drawer" nil)
2936           (const :tag "LOGBOOK" t)
2937           (string :tag "Other")))
2938
2939 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2940
2941 (defun org-log-into-drawer ()
2942   "Name of the log drawer, as a string, or nil.
2943 This is the value of `org-log-into-drawer'.  However, if the
2944 current entry has or inherits a LOG_INTO_DRAWER property, it will
2945 be used instead of the default value."
2946   (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2947     (cond ((equal p "nil") nil)
2948           ((equal p "t") "LOGBOOK")
2949           ((stringp p) p)
2950           (p "LOGBOOK")
2951           ((stringp org-log-into-drawer) org-log-into-drawer)
2952           (org-log-into-drawer "LOGBOOK"))))
2953
2954 (defcustom org-log-state-notes-insert-after-drawers nil
2955   "Non-nil means insert state change notes after any drawers in entry.
2956 Only the drawers that *immediately* follow the headline and the
2957 deadline/scheduled line are skipped.
2958 When nil, insert notes right after the heading and perhaps the line
2959 with deadline/scheduling if present.
2960
2961 This variable will have no effect if `org-log-into-drawer' is
2962 set."
2963   :group 'org-todo
2964   :group 'org-progress
2965   :type 'boolean)
2966
2967 (defcustom org-log-states-order-reversed t
2968   "Non-nil means the latest state note will be directly after heading.
2969 When nil, the state change notes will be ordered according to time.
2970
2971 This option can also be set with on a per-file-basis with
2972
2973    #+STARTUP: logstatesreversed
2974    #+STARTUP: nologstatesreversed"
2975   :group 'org-todo
2976   :group 'org-progress
2977   :type 'boolean)
2978
2979 (defcustom org-todo-repeat-to-state nil
2980   "The TODO state to which a repeater should return the repeating task.
2981 By default this is the first task in a TODO sequence, or the previous state
2982 in a TODO_TYP set.  But you can specify another task here.
2983 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2984   :group 'org-todo
2985   :version "24.1"
2986   :type '(choice (const :tag "Head of sequence" nil)
2987                  (string :tag "Specific state")))
2988
2989 (defcustom org-log-repeat 'time
2990   "Non-nil means record moving through the DONE state when triggering repeat.
2991 An auto-repeating task is immediately switched back to TODO when
2992 marked DONE.  If you are not logging state changes (by adding \"@\"
2993 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2994 record a closing note, there will be no record of the task moving
2995 through DONE.  This variable forces taking a note anyway.
2996
2997 nil     Don't force a record
2998 time    Record a time stamp
2999 note    Prompt for a note and add it with template `org-log-note-headings'
3000
3001 This option can also be set with on a per-file-basis with
3002
3003    #+STARTUP: nologrepeat
3004    #+STARTUP: logrepeat
3005    #+STARTUP: lognoterepeat
3006
3007 You can have local logging settings for a subtree by setting the LOGGING
3008 property to one or more of these keywords."
3009   :group 'org-todo
3010   :group 'org-progress
3011   :type '(choice
3012           (const :tag "Don't force a record" nil)
3013           (const :tag "Force recording the DONE state" time)
3014           (const :tag "Force recording a note with the DONE state" note)))
3015
3016
3017 (defgroup org-priorities nil
3018   "Priorities in Org-mode."
3019   :tag "Org Priorities"
3020   :group 'org-todo)
3021
3022 (defcustom org-enable-priority-commands t
3023   "Non-nil means priority commands are active.
3024 When nil, these commands will be disabled, so that you never accidentally
3025 set a priority."
3026   :group 'org-priorities
3027   :type 'boolean)
3028
3029 (defcustom org-highest-priority ?A
3030   "The highest priority of TODO items.  A character like ?A, ?B etc.
3031 Must have a smaller ASCII number than `org-lowest-priority'."
3032   :group 'org-priorities
3033   :type 'character)
3034
3035 (defcustom org-lowest-priority ?C
3036   "The lowest priority of TODO items.  A character like ?A, ?B etc.
3037 Must have a larger ASCII number than `org-highest-priority'."
3038   :group 'org-priorities
3039   :type 'character)
3040
3041 (defcustom org-default-priority ?B
3042   "The default priority of TODO items.
3043 This is the priority an item gets if no explicit priority is given.
3044 When starting to cycle on an empty priority the first step in the cycle
3045 depends on `org-priority-start-cycle-with-default'.  The resulting first
3046 step priority must not exceed the range from `org-highest-priority' to
3047 `org-lowest-priority' which means that `org-default-priority' has to be
3048 in this range exclusive or inclusive the range boundaries.  Else the
3049 first step refuses to set the default and the second will fall back
3050 to (depending on the command used) the highest or lowest priority."
3051   :group 'org-priorities
3052   :type 'character)
3053
3054 (defcustom org-priority-start-cycle-with-default t
3055   "Non-nil means start with default priority when starting to cycle.
3056 When this is nil, the first step in the cycle will be (depending on the
3057 command used) one higher or lower than the default priority.
3058 See also `org-default-priority'."
3059   :group 'org-priorities
3060   :type 'boolean)
3061
3062 (defcustom org-get-priority-function nil
3063   "Function to extract the priority from a string.
3064 The string is normally the headline.  If this is nil Org computes the
3065 priority from the priority cookie like [#A] in the headline.  It returns
3066 an integer, increasing by 1000 for each priority level.
3067 The user can set a different function here, which should take a string
3068 as an argument and return the numeric priority."
3069   :group 'org-priorities
3070   :version "24.1"
3071   :type '(choice
3072           (const nil)
3073           (function)))
3074
3075 (defgroup org-time nil
3076   "Options concerning time stamps and deadlines in Org-mode."
3077   :tag "Org Time"
3078   :group 'org)
3079
3080 (defcustom org-time-stamp-rounding-minutes '(0 5)
3081   "Number of minutes to round time stamps to.
3082 \\<org-mode-map>\
3083 These are two values, the first applies when first creating a time stamp.
3084 The second applies when changing it with the commands `S-up' and `S-down'.
3085 When changing the time stamp, this means that it will change in steps
3086 of N minutes, as given by the second value.
3087
3088 When a setting is 0 or 1, insert the time unmodified.  Useful rounding
3089 numbers should be factors of 60, so for example 5, 10, 15.
3090
3091 When this is larger than 1, you can still force an exact time stamp by using
3092 a double prefix argument to a time stamp command like \
3093 `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
3094 and by using a prefix arg to `S-up/down' to specify the exact number
3095 of minutes to shift."
3096   :group 'org-time
3097   :get (lambda (var) ; Make sure both elements are there
3098          (if (integerp (default-value var))
3099              (list (default-value var) 5)
3100            (default-value var)))
3101   :type '(list
3102           (integer :tag "when inserting times")
3103           (integer :tag "when modifying times")))
3104
3105 ;; Normalize old customizations of this variable.
3106 (when (integerp org-time-stamp-rounding-minutes)
3107   (setq org-time-stamp-rounding-minutes
3108         (list org-time-stamp-rounding-minutes
3109               org-time-stamp-rounding-minutes)))
3110
3111 (defcustom org-display-custom-times nil
3112   "Non-nil means overlay custom formats over all time stamps.
3113 The formats are defined through the variable `org-time-stamp-custom-formats'.
3114 To turn this on on a per-file basis, insert anywhere in the file:
3115    #+STARTUP: customtime"
3116   :group 'org-time
3117   :set 'set-default
3118   :type 'sexp)
3119 (make-variable-buffer-local 'org-display-custom-times)
3120
3121 (defcustom org-time-stamp-custom-formats
3122   '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3123   "Custom formats for time stamps.  See `format-time-string' for the syntax.
3124 These are overlaid over the default ISO format if the variable
3125 `org-display-custom-times' is set.  Time like %H:%M should be at the
3126 end of the second format.  The custom formats are also honored by export
3127 commands, if custom time display is turned on at the time of export."
3128   :group 'org-time
3129   :type 'sexp)
3130
3131 (defun org-time-stamp-format (&optional long inactive)
3132   "Get the right format for a time string."
3133   (let ((f (if long (cdr org-time-stamp-formats)
3134              (car org-time-stamp-formats))))
3135     (if inactive
3136         (concat "[" (substring f 1 -1) "]")
3137       f)))
3138
3139 (defcustom org-time-clocksum-format
3140   '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3141   "The format string used when creating CLOCKSUM lines.
3142 This is also used when Org mode generates a time duration.
3143
3144 The value can be a single format string containing two
3145 %-sequences, which will be filled with the number of hours and
3146 minutes in that order.
3147
3148 Alternatively, the value can be a plist associating any of the
3149 keys :years, :months, :weeks, :days, :hours or :minutes with
3150 format strings.  The time duration is formatted using only the
3151 time components that are needed and concatenating the results.
3152 If a time unit in absent, it falls back to the next smallest
3153 unit.
3154
3155 The keys :require-years, :require-months, :require-days,
3156 :require-weeks, :require-hours, :require-minutes are also
3157 meaningful.  A non-nil value for these keys indicates that the
3158 corresponding time component should always be included, even if
3159 its value is 0.
3160
3161
3162 For example,
3163
3164    (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3165     :require-minutes t)
3166
3167 means durations longer than a day will be expressed in days,
3168 hours and minutes, and durations less than a day will always be
3169 expressed in hours and minutes (even for durations less than an
3170 hour).
3171
3172 The value
3173
3174   (:days \"%dd\" :minutes \"%dm\")
3175
3176 means durations longer than a day will be expressed in days and
3177 minutes, and durations less than a day will be expressed entirely
3178 in minutes (even for durations longer than an hour)."
3179   :group 'org-time
3180   :group 'org-clock
3181   :version "24.4"
3182   :package-version '(Org . "8.0")
3183   :type '(choice (string :tag "Format string")
3184                  (set :tag "Plist"
3185                       (group :inline t (const :tag "Years" :years)
3186                              (string :tag "Format string"))
3187                       (group :inline t
3188                              (const :tag "Always show years" :require-years)
3189                              (const t))
3190                       (group :inline t (const :tag "Months" :months)
3191                              (string :tag "Format string"))
3192                       (group :inline t
3193                              (const :tag "Always show months" :require-months)
3194                              (const t))
3195                       (group :inline t (const :tag "Weeks" :weeks)
3196                              (string :tag "Format string"))
3197                       (group :inline t
3198                              (const :tag "Always show weeks" :require-weeks)
3199                              (const t))
3200                       (group :inline t (const :tag "Days" :days)
3201                              (string :tag "Format string"))
3202                       (group :inline t
3203                              (const :tag "Always show days" :require-days)
3204                              (const t))
3205                       (group :inline t (const :tag "Hours" :hours)
3206                              (string :tag "Format string"))
3207                       (group :inline t
3208                              (const :tag "Always show hours" :require-hours)
3209                              (const t))
3210                       (group :inline t (const :tag "Minutes" :minutes)
3211                              (string :tag "Format string"))
3212                       (group :inline t
3213                              (const :tag "Always show minutes" :require-minutes)
3214                              (const t)))))
3215
3216 (defcustom org-time-clocksum-use-fractional nil
3217   "When non-nil, \\[org-clock-display] uses fractional times.
3218 See `org-time-clocksum-format' for more on time clock formats."
3219   :group 'org-time
3220   :group 'org-clock
3221   :version "24.3"
3222   :type 'boolean)
3223
3224 (defcustom org-time-clocksum-use-effort-durations nil
3225   "When non-nil, \\[org-clock-display] uses effort durations.
3226 E.g. by default, one day is considered to be a 8 hours effort,
3227 so a task that has been clocked for 16 hours will be displayed
3228 as during 2 days in the clock display or in the clocktable.
3229
3230 See `org-effort-durations' on how to set effort durations
3231 and `org-time-clocksum-format' for more on time clock formats."
3232   :group 'org-time
3233   :group 'org-clock
3234   :version "24.4"
3235   :package-version '(Org . "8.0")
3236   :type 'boolean)
3237
3238 (defcustom org-time-clocksum-fractional-format "%.2f"
3239   "The format string used when creating CLOCKSUM lines,
3240 or when Org mode generates a time duration, if
3241 `org-time-clocksum-use-fractional' is enabled.
3242
3243 The value can be a single format string containing one
3244 %-sequence, which will be filled with the number of hours as
3245 a float.
3246
3247 Alternatively, the value can be a plist associating any of the
3248 keys :years, :months, :weeks, :days, :hours or :minutes with
3249 a format string.  The time duration is formatted using the
3250 largest time unit which gives a non-zero integer part.  If all
3251 specified formats have zero integer part, the smallest time unit
3252 is used."
3253   :group 'org-time
3254   :type '(choice (string :tag "Format string")
3255                  (set (group :inline t (const :tag "Years" :years)
3256                              (string :tag "Format string"))
3257                       (group :inline t (const :tag "Months" :months)
3258                              (string :tag "Format string"))
3259                       (group :inline t (const :tag "Weeks" :weeks)
3260                              (string :tag "Format string"))
3261                       (group :inline t (const :tag "Days" :days)
3262                              (string :tag "Format string"))
3263                       (group :inline t (const :tag "Hours" :hours)
3264                              (string :tag "Format string"))
3265                       (group :inline t (const :tag "Minutes" :minutes)
3266                              (string :tag "Format string")))))
3267
3268 (defcustom org-deadline-warning-days 14
3269   "Number of days before expiration during which a deadline becomes active.
3270 This variable governs the display in sparse trees and in the agenda.
3271 When 0 or negative, it means use this number (the absolute value of it)
3272 even if a deadline has a different individual lead time specified.
3273
3274 Custom commands can set this variable in the options section."
3275   :group 'org-time
3276   :group 'org-agenda-daily/weekly
3277   :type 'integer)
3278
3279 (defcustom org-scheduled-delay-days 0
3280   "Number of days before a scheduled item becomes active.
3281 This variable governs the display in sparse trees and in the agenda.
3282 The default value (i.e. 0) means: don't delay scheduled item.
3283 When negative, it means use this number (the absolute value of it)
3284 even if a scheduled item has a different individual delay time
3285 specified.
3286
3287 Custom commands can set this variable in the options section."
3288   :group 'org-time
3289   :group 'org-agenda-daily/weekly
3290   :version "24.4"
3291   :package-version '(Org . "8.0")
3292   :type 'integer)
3293
3294 (defcustom org-read-date-prefer-future t
3295   "Non-nil means assume future for incomplete date input from user.
3296 This affects the following situations:
3297 1. The user gives a month but not a year.
3298    For example, if it is April and you enter \"feb 2\", this will be read
3299    as Feb 2, *next* year.  \"May 5\", however, will be this year.
3300 2. The user gives a day, but no month.
3301    For example, if today is the 15th, and you enter \"3\", Org-mode will
3302    read this as the third of *next* month.  However, if you enter \"17\",
3303    it will be considered as *this* month.
3304
3305 If you set this variable to the symbol `time', then also the following
3306 will work:
3307
3308 3. If the user gives a time.
3309    If the time is before now, it will be interpreted as tomorrow.
3310
3311 Currently none of this works for ISO week specifications.
3312
3313 When this option is nil, the current day, month and year will always be
3314 used as defaults.
3315
3316 See also `org-agenda-jump-prefer-future'."
3317   :group 'org-time
3318   :type '(choice
3319           (const :tag "Never" nil)
3320           (const :tag "Check month and day" t)
3321           (const :tag "Check month, day, and time" time)))
3322
3323 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3324   "Should the agenda jump command prefer the future for incomplete dates?
3325 The default is to do the same as configured in `org-read-date-prefer-future'.
3326 But you can also set a deviating value here.
3327 This may t or nil, or the symbol `org-read-date-prefer-future'."
3328   :group 'org-agenda
3329   :group 'org-time
3330   :version "24.1"
3331   :type '(choice
3332           (const :tag "Use org-read-date-prefer-future"
3333                  org-read-date-prefer-future)
3334           (const :tag "Never" nil)
3335           (const :tag "Always" t)))
3336
3337 (defcustom org-read-date-force-compatible-dates t
3338   "Should date/time prompt force dates that are guaranteed to work in Emacs?
3339
3340 Depending on the system Emacs is running on, certain dates cannot
3341 be represented with the type used internally to represent time.
3342 Dates between 1970-1-1 and 2038-1-1 can always be represented
3343 correctly.  Some systems allow for earlier dates, some for later,
3344 some for both.  One way to find out it to insert any date into an
3345 Org buffer, putting the cursor on the year and hitting S-up and
3346 S-down to test the range.
3347
3348 When this variable is set to t, the date/time prompt will not let
3349 you specify dates outside the 1970-2037 range, so it is certain that
3350 these dates will work in whatever version of Emacs you are
3351 running, and also that you can move a file from one Emacs implementation
3352 to another.  WHenever Org is forcing the year for you, it will display
3353 a message and beep.
3354
3355 When this variable is nil, Org will check if the date is
3356 representable in the specific Emacs implementation you are using.
3357 If not, it will force a year, usually the current year, and beep
3358 to remind you.  Currently this setting is not recommended because
3359 the likelihood that you will open your Org files in an Emacs that
3360 has limited date range is not negligible.
3361
3362 A workaround for this problem is to use diary sexp dates for time
3363 stamps outside of this range."
3364   :group 'org-time
3365   :version "24.1"
3366   :type 'boolean)
3367
3368 (defcustom org-read-date-display-live t
3369   "Non-nil means display current interpretation of date prompt live.
3370 This display will be in an overlay, in the minibuffer."
3371   :group 'org-time
3372   :type 'boolean)
3373
3374 (defcustom org-read-date-popup-calendar t
3375   "Non-nil means pop up a calendar when prompting for a date.
3376 In the calendar, the date can be selected with mouse-1.  However, the
3377 minibuffer will also be active, and you can simply enter the date as well.
3378 When nil, only the minibuffer will be available."
3379   :group 'org-time
3380   :type 'boolean)
3381 (org-defvaralias 'org-popup-calendar-for-date-prompt
3382   'org-read-date-popup-calendar)
3383
3384 (make-obsolete-variable
3385  'org-read-date-minibuffer-setup-hook
3386  "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3387 (defcustom org-read-date-minibuffer-setup-hook nil
3388   "Hook to be used to set up keys for the date/time interface.
3389 Add key definitions to `minibuffer-local-map', which will be a
3390 temporary copy.
3391
3392 WARNING: This option is obsolete, you should use
3393 `org-read-date-minibuffer-local-map' to set up keys."
3394   :group 'org-time
3395   :type 'hook)
3396
3397 (defcustom org-extend-today-until 0
3398   "The hour when your day really ends.  Must be an integer.
3399 This has influence for the following applications:
3400 - When switching the agenda to \"today\".  It it is still earlier than
3401   the time given here, the day recognized as TODAY is actually yesterday.
3402 - When a date is read from the user and it is still before the time given
3403   here, the current date and time will be assumed to be yesterday, 23:59.
3404   Also, timestamps inserted in capture templates follow this rule.
3405
3406 IMPORTANT:  This is a feature whose implementation is and likely will
3407 remain incomplete.  Really, it is only here because past midnight seems to
3408 be the favorite working time of John Wiegley :-)"
3409   :group 'org-time
3410   :type 'integer)
3411
3412 (defcustom org-use-effective-time nil
3413   "If non-nil, consider `org-extend-today-until' when creating timestamps.
3414 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3415 \"effective time\" of any timestamps between midnight and 8am will be
3416 23:59 of the previous day."
3417   :group 'org-time
3418   :version "24.1"
3419   :type 'boolean)
3420
3421 (defcustom org-use-last-clock-out-time-as-effective-time nil
3422   "When non-nil, use the last clock out time for `org-todo'.
3423 Note that this option has precedence over the combined use of
3424 `org-use-effective-time' and `org-extend-today-until'."
3425   :group 'org-time
3426   :version "24.4"
3427   :package-version '(Org . "8.0")
3428   :type 'boolean)
3429
3430 (defcustom org-edit-timestamp-down-means-later nil
3431   "Non-nil means S-down will increase the time in a time stamp.
3432 When nil, S-up will increase."
3433   :group 'org-time
3434   :type 'boolean)
3435
3436 (defcustom org-calendar-follow-timestamp-change t
3437   "Non-nil means make the calendar window follow timestamp changes.
3438 When a timestamp is modified and the calendar window is visible, it will be
3439 moved to the new date."
3440   :group 'org-time
3441   :type 'boolean)
3442
3443 (defgroup org-tags nil
3444   "Options concerning tags in Org-mode."
3445   :tag "Org Tags"
3446   :group 'org)
3447
3448 (defcustom org-tag-alist nil
3449   "List of tags allowed in Org-mode files.
3450 When this list is nil, Org-mode will base TAG input on what is already in the
3451 buffer.
3452 The value of this variable is an alist, the car of each entry must be a
3453 keyword as a string, the cdr may be a character that is used to select
3454 that tag through the fast-tag-selection interface.
3455 See the manual for details."
3456   :group 'org-tags
3457   :type '(repeat
3458           (choice
3459            (cons   (string    :tag "Tag name")
3460                    (character :tag "Access char"))
3461            (list :tag "Start radio group"
3462                  (const :startgroup)
3463                  (option (string :tag "Group description")))
3464            (list :tag "Start tag group, non distinct"
3465                  (const :startgrouptag)
3466                  (option (string :tag "Group description")))
3467            (list :tag "Group tags delimiter"
3468                  (const :grouptags))
3469            (list :tag "End radio group"
3470                  (const :endgroup)
3471                  (option (string :tag "Group description")))
3472            (list :tag "End tag group, non distinct"
3473                  (const :endgrouptag)
3474                  (option (string :tag "Group description")))
3475            (const :tag "New line" (:newline)))))
3476
3477 (defcustom org-tag-persistent-alist nil
3478   "List of tags that will always appear in all Org-mode files.
3479 This is in addition to any in buffer settings or customizations
3480 of `org-tag-alist'.
3481 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3482 The value of this variable is an alist, the car of each entry must be a
3483 keyword as a string, the cdr may be a character that is used to select
3484 that tag through the fast-tag-selection interface.
3485 See the manual for details.
3486 To disable these tags on a per-file basis, insert anywhere in the file:
3487    #+STARTUP: noptag"
3488   :group 'org-tags
3489   :type '(repeat
3490           (choice
3491            (cons   (string    :tag "Tag name")
3492                    (character :tag "Access char"))
3493            (const :tag "Start radio group" (:startgroup))
3494            (const :tag "Group tags delimiter" (:grouptags))
3495            (const :tag "End radio group" (:endgroup))
3496            (const :tag "New line" (:newline)))))
3497
3498 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3499   "If non-nil, always offer completion for all tags of all agenda files.
3500 Instead of customizing this variable directly, you might want to
3501 set it locally for capture buffers, because there no list of
3502 tags in that file can be created dynamically (there are none).
3503
3504   (add-hook \\='org-capture-mode-hook
3505             (lambda ()
3506               (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
3507   :group 'org-tags
3508   :version "24.1"
3509   :type 'boolean)
3510
3511 (defvar org-file-tags nil
3512   "List of tags that can be inherited by all entries in the file.
3513 The tags will be inherited if the variable `org-use-tag-inheritance'
3514 says they should be.
3515 This variable is populated from #+FILETAGS lines.")
3516
3517 (defcustom org-use-fast-tag-selection 'auto
3518   "Non-nil means use fast tag selection scheme.
3519 This is a special interface to select and deselect tags with single keys.
3520 When nil, fast selection is never used.
3521 When the symbol `auto', fast selection is used if and only if selection
3522 characters for tags have been configured, either through the variable
3523 `org-tag-alist' or through a #+TAGS line in the buffer.
3524 When t, fast selection is always used and selection keys are assigned
3525 automatically if necessary."
3526   :group 'org-tags
3527   :type '(choice
3528           (const :tag "Always" t)
3529           (const :tag "Never" nil)
3530           (const :tag "When selection characters are configured" auto)))
3531
3532 (defcustom org-fast-tag-selection-single-key nil
3533   "Non-nil means fast tag selection exits after first change.
3534 When nil, you have to press RET to exit it.
3535 During fast tag selection, you can toggle this flag with `C-c'.
3536 This variable can also have the value `expert'.  In this case, the window
3537 displaying the tags menu is not even shown, until you press C-c again."
3538   :group 'org-tags
3539   :type '(choice
3540           (const :tag "No" nil)
3541           (const :tag "Yes" t)
3542           (const :tag "Expert" expert)))
3543
3544 (defvar org-fast-tag-selection-include-todo nil
3545   "Non-nil means fast tags selection interface will also offer TODO states.
3546 This is an undocumented feature, you should not rely on it.")
3547
3548 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3549   "The column to which tags should be indented in a headline.
3550 If this number is positive, it specifies the column.  If it is negative,
3551 it means that the tags should be flushright to that column.  For example,
3552 -80 works well for a normal 80 character screen.
3553 When 0, place tags directly after headline text, with only one space in
3554 between."
3555   :group 'org-tags
3556   :type 'integer)
3557
3558 (defcustom org-auto-align-tags t
3559   "Non-nil keeps tags aligned when modifying headlines.
3560 Some operations (i.e. demoting) change the length of a headline and
3561 therefore shift the tags around.  With this option turned on, after
3562 each such operation the tags are again aligned to `org-tags-column'."
3563   :group 'org-tags
3564   :type 'boolean)
3565
3566 (defcustom org-use-tag-inheritance t
3567   "Non-nil means tags in levels apply also for sublevels.
3568 When nil, only the tags directly given in a specific line apply there.
3569 This may also be a list of tags that should be inherited, or a regexp that
3570 matches tags that should be inherited.  Additional control is possible
3571 with the variable  `org-tags-exclude-from-inheritance' which gives an
3572 explicit list of tags to be excluded from inheritance, even if the value of
3573 `org-use-tag-inheritance' would select it for inheritance.
3574
3575 If this option is t, a match early-on in a tree can lead to a large
3576 number of matches in the subtree when constructing the agenda or creating
3577 a sparse tree.  If you only want to see the first match in a tree during
3578 a search, check out the variable `org-tags-match-list-sublevels'."
3579   :group 'org-tags
3580   :type '(choice
3581           (const :tag "Not" nil)
3582           (const :tag "Always" t)
3583           (repeat :tag "Specific tags" (string :tag "Tag"))
3584           (regexp :tag "Tags matched by regexp")))
3585
3586 (defcustom org-tags-exclude-from-inheritance nil
3587   "List of tags that should never be inherited.
3588 This is a way to exclude a few tags from inheritance.  For way to do
3589 the opposite, to actively allow inheritance for selected tags,
3590 see the variable `org-use-tag-inheritance'."
3591   :group 'org-tags
3592   :type '(repeat (string :tag "Tag")))
3593
3594 (defun org-tag-inherit-p (tag)
3595   "Check if TAG is one that should be inherited."
3596   (cond
3597    ((member tag org-tags-exclude-from-inheritance) nil)
3598    ((eq org-use-tag-inheritance t) t)
3599    ((not org-use-tag-inheritance) nil)
3600    ((stringp org-use-tag-inheritance)
3601     (string-match org-use-tag-inheritance tag))
3602    ((listp org-use-tag-inheritance)
3603     (member tag org-use-tag-inheritance))
3604    (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3605
3606 (defcustom org-tags-match-list-sublevels t
3607   "Non-nil means list also sublevels of headlines matching a search.
3608 This variable applies to tags/property searches, and also to stuck
3609 projects because this search is based on a tags match as well.
3610
3611 When set to the symbol `indented', sublevels are indented with
3612 leading dots.
3613
3614 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3615 the sublevels of a headline matching a tag search often also match
3616 the same search.  Listing all of them can create very long lists.
3617 Setting this variable to nil causes subtrees of a match to be skipped.
3618
3619 This variable is semi-obsolete and probably should always be true.  It
3620 is better to limit inheritance to certain tags using the variables
3621 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3622   :group 'org-tags
3623   :type '(choice
3624           (const :tag "No, don't list them" nil)
3625           (const :tag "Yes, do list them" t)
3626           (const :tag "List them, indented with leading dots" indented)))
3627
3628 (defcustom org-tags-sort-function nil
3629   "When set, tags are sorted using this function as a comparator."
3630   :group 'org-tags
3631   :type '(choice
3632           (const :tag "No sorting" nil)
3633           (const :tag "Alphabetical" string<)
3634           (const :tag "Reverse alphabetical" string>)
3635           (function :tag "Custom function" nil)))
3636
3637 (defvar org-tags-history nil
3638   "History of minibuffer reads for tags.")
3639 (defvar org-last-tags-completion-table nil
3640   "The last used completion table for tags.")
3641 (defvar org-after-tags-change-hook nil
3642   "Hook that is run after the tags in a line have changed.")
3643
3644 (defgroup org-properties nil
3645   "Options concerning properties in Org-mode."
3646   :tag "Org Properties"
3647   :group 'org)
3648
3649 (defcustom org-property-format "%-10s %s"
3650   "How property key/value pairs should be formatted by `indent-line'.
3651 When `indent-line' hits a property definition, it will format the line
3652 according to this format, mainly to make sure that the values are
3653 lined-up with respect to each other."
3654   :group 'org-properties
3655   :type 'string)
3656
3657 (defcustom org-properties-postprocess-alist nil
3658   "Alist of properties and functions to adjust inserted values.
3659 Elements of this alist must be of the form
3660
3661   ([string] [function])
3662
3663 where [string] must be a property name and [function] must be a
3664 lambda expression: this lambda expression must take one argument,
3665 the value to adjust, and return the new value as a string.
3666
3667 For example, this element will allow the property \"Remaining\"
3668 to be updated wrt the relation between the \"Effort\" property
3669 and the clock summary:
3670
3671  ((\"Remaining\" (lambda(value)
3672                    (let ((clocksum (org-clock-sum-current-item))
3673                          (effort (org-duration-string-to-minutes
3674                                    (org-entry-get (point) \"Effort\"))))
3675                      (org-minutes-to-clocksum-string (- effort clocksum))))))"
3676   :group 'org-properties
3677   :version "24.1"
3678   :type '(alist :key-type (string     :tag "Property")
3679                 :value-type (function :tag "Function")))
3680
3681 (defcustom org-use-property-inheritance nil
3682   "Non-nil means properties apply also for sublevels.
3683
3684 This setting is chiefly used during property searches.  Turning it on can
3685 cause significant overhead when doing a search, which is why it is not
3686 on by default.
3687
3688 When nil, only the properties directly given in the current entry count.
3689 When t, every property is inherited.  The value may also be a list of
3690 properties that should have inheritance, or a regular expression matching
3691 properties that should be inherited.
3692
3693 However, note that some special properties use inheritance under special
3694 circumstances (not in searches).  Examples are CATEGORY, ARCHIVE, COLUMNS,
3695 and the properties ending in \"_ALL\" when they are used as descriptor
3696 for valid values of a property.
3697
3698 Note for programmers:
3699 When querying an entry with `org-entry-get',  you can control if inheritance
3700 should be used.  By default, `org-entry-get' looks only at the local
3701 properties.  You can request inheritance by setting the inherit argument
3702 to t (to force inheritance) or to `selective' (to respect the setting
3703 in this variable)."
3704   :group 'org-properties
3705   :type '(choice
3706           (const :tag "Not" nil)
3707           (const :tag "Always" t)
3708           (repeat :tag "Specific properties" (string :tag "Property"))
3709           (regexp :tag "Properties matched by regexp")))
3710
3711 (defun org-property-inherit-p (property)
3712   "Check if PROPERTY is one that should be inherited."
3713   (cond
3714    ((eq org-use-property-inheritance t) t)
3715    ((not org-use-property-inheritance) nil)
3716    ((stringp org-use-property-inheritance)
3717     (string-match org-use-property-inheritance property))
3718    ((listp org-use-property-inheritance)
3719     (member property org-use-property-inheritance))
3720    (t (error "Invalid setting of `org-use-property-inheritance'"))))
3721
3722 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3723   "The default column format, if no other format has been defined.
3724 This variable can be set on the per-file basis by inserting a line
3725
3726 #+COLUMNS: %25ITEM ....."
3727   :group 'org-properties
3728   :type 'string)
3729
3730 (defcustom org-columns-ellipses ".."
3731   "The ellipses to be used when a field in column view is truncated.
3732 When this is the empty string, as many characters as possible are shown,
3733 but then there will be no visual indication that the field has been truncated.
3734 When this is a string of length N, the last N characters of a truncated
3735 field are replaced by this string.  If the column is narrower than the
3736 ellipses string, only part of the ellipses string will be shown."
3737   :group 'org-properties
3738   :type 'string)
3739
3740 (defcustom org-columns-modify-value-for-display-function nil
3741   "Function that modifies values for display in column view.
3742 For example, it can be used to cut out a certain part from a time stamp.
3743 The function must take 2 arguments:
3744
3745 column-title    The title of the column (*not* the property name)
3746 value           The value that should be modified.
3747
3748 The function should return the value that should be displayed,
3749 or nil if the normal value should be used."
3750   :group 'org-properties
3751   :type '(choice (const nil) (function)))
3752
3753 (defconst org-global-properties-fixed
3754   '(("VISIBILITY_ALL" . "folded children content all")
3755     ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3756   "List of property/value pairs that can be inherited by any entry.
3757
3758 These are fixed values, for the preset properties.  The user variable
3759 that can be used to add to this list is `org-global-properties'.
3760
3761 The entries in this list are cons cells where the car is a property
3762 name and cdr is a string with the value.  If the value represents
3763 multiple items like an \"_ALL\" property, separate the items by
3764 spaces.")
3765
3766 (defcustom org-global-properties nil
3767   "List of property/value pairs that can be inherited by any entry.
3768
3769 This list will be combined with the constant `org-global-properties-fixed'.
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.
3773
3774 You can set buffer-local values for the same purpose in the variable
3775 `org-file-properties' this by adding lines like
3776
3777 #+PROPERTY: NAME VALUE"
3778   :group 'org-properties
3779   :type '(repeat
3780           (cons (string :tag "Property")
3781                 (string :tag "Value"))))
3782
3783 (defvar-local org-file-properties nil
3784   "List of property/value pairs that can be inherited by any entry.
3785 Valid for the current buffer.
3786 This variable is populated from #+PROPERTY lines.")
3787
3788 (defgroup org-agenda nil
3789   "Options concerning agenda views in Org-mode."
3790   :tag "Org Agenda"
3791   :group 'org)
3792
3793 (defvar-local org-category nil
3794   "Variable used by org files to set a category for agenda display.
3795 Such files should use a file variable to set it, for example
3796
3797 #   -*- mode: org; org-category: \"ELisp\"
3798
3799 or contain a special line
3800
3801 #+CATEGORY: ELisp
3802
3803 If the file does not specify a category, then file's base name
3804 is used instead.")
3805 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3806
3807 (defcustom org-agenda-files nil
3808   "The files to be used for agenda display.
3809 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3810 \\[org-remove-file].  You can also use customize to edit the list.
3811
3812 If an entry is a directory, all files in that directory that are matched by
3813 `org-agenda-file-regexp' will be part of the file list.
3814
3815 If the value of the variable is not a list but a single file name, then
3816 the list of agenda files is actually stored and maintained in that file, one
3817 agenda file per line.  In this file paths can be given relative to
3818 `org-directory'.  Tilde expansion and environment variable substitution
3819 are also made."
3820   :group 'org-agenda
3821   :type '(choice
3822           (repeat :tag "List of files and directories" file)
3823           (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3824
3825 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3826   "Regular expression to match files for `org-agenda-files'.
3827 If any element in the list in that variable contains a directory instead
3828 of a normal file, all files in that directory that are matched by this
3829 regular expression will be included."
3830   :group 'org-agenda
3831   :type 'regexp)
3832
3833 (defcustom org-agenda-text-search-extra-files nil
3834   "List of extra files to be searched by text search commands.
3835 These files will be searched in addition to the agenda files by the
3836 commands `org-search-view' (`\\[org-agenda] s') \
3837 and `org-occur-in-agenda-files'.
3838 Note that these files will only be searched for text search commands,
3839 not for the other agenda views like todo lists, tag searches or the weekly
3840 agenda.  This variable is intended to list notes and possibly archive files
3841 that should also be searched by these two commands.
3842 In fact, if the first element in the list is the symbol `agenda-archives',
3843 then all archive files of all agenda files will be added to the search
3844 scope."
3845   :group 'org-agenda
3846   :type '(set :greedy t
3847               (const :tag "Agenda Archives" agenda-archives)
3848               (repeat :inline t (file))))
3849
3850 (org-defvaralias 'org-agenda-multi-occur-extra-files
3851   'org-agenda-text-search-extra-files)
3852
3853 (defcustom org-agenda-skip-unavailable-files nil
3854   "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3855 A nil value means to remove them, after a query, from the list."
3856   :group 'org-agenda
3857   :type 'boolean)
3858
3859 (defcustom org-calendar-to-agenda-key [?c]
3860   "The key to be installed in `calendar-mode-map' for switching to the agenda.
3861 The command `org-calendar-goto-agenda' will be bound to this key.  The
3862 default is the character `c' because then `c' can be used to switch back and
3863 forth between agenda and calendar."
3864   :group 'org-agenda
3865   :type 'sexp)
3866
3867 (defcustom org-calendar-insert-diary-entry-key [?i]
3868   "The key to be installed in `calendar-mode-map' for adding diary entries.
3869 This option is irrelevant until `org-agenda-diary-file' has been configured
3870 to point to an Org-mode file.  When that is the case, the command
3871 `org-agenda-diary-entry' will be bound to the key given here, by default
3872 `i'.  In the calendar, `i' normally adds entries to `diary-file'.  So
3873 if you want to continue doing this, you need to change this to a different
3874 key."
3875   :group 'org-agenda
3876   :type 'sexp)
3877
3878 (defcustom org-agenda-diary-file 'diary-file
3879   "File to which to add new entries with the `i' key in agenda and calendar.
3880 When this is the symbol `diary-file', the functionality in the Emacs
3881 calendar will be used to add entries to the `diary-file'.  But when this
3882 points to a file, `org-agenda-diary-entry' will be used instead."
3883   :group 'org-agenda
3884   :type '(choice
3885           (const :tag "The standard Emacs diary file" diary-file)
3886           (file :tag "Special Org file diary entries")))
3887
3888 (eval-after-load "calendar"
3889   '(progn
3890      (org-defkey calendar-mode-map org-calendar-to-agenda-key
3891                  'org-calendar-goto-agenda)
3892      (add-hook 'calendar-mode-hook
3893                (lambda ()
3894                  (unless (eq org-agenda-diary-file 'diary-file)
3895                    (define-key calendar-mode-map
3896                      org-calendar-insert-diary-entry-key
3897                      'org-agenda-diary-entry))))))
3898
3899 (defgroup org-latex nil
3900   "Options for embedding LaTeX code into Org-mode."
3901   :tag "Org LaTeX"
3902   :group 'org)
3903
3904 (defcustom org-format-latex-options
3905   '(:foreground default :background default :scale 1.0
3906                 :html-foreground "Black" :html-background "Transparent"
3907                 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3908   "Options for creating images from LaTeX fragments.
3909 This is a property list with the following properties:
3910 :foreground  the foreground color for images embedded in Emacs, e.g. \"Black\".
3911              `default' means use the foreground of the default face.
3912              `auto' means use the foreground from the text face.
3913 :background  the background color, or \"Transparent\".
3914              `default' means use the background of the default face.
3915              `auto' means use the background from the text face.
3916 :scale       a scaling factor for the size of the images, to get more pixels
3917 :html-foreground, :html-background, :html-scale
3918              the same numbers for HTML export.
3919 :matchers    a list indicating which matchers should be used to
3920              find LaTeX fragments.  Valid members of this list are:
3921              \"begin\" find environments
3922              \"$1\"    find single characters surrounded by $.$
3923              \"$\"     find math expressions surrounded by $...$
3924              \"$$\"    find math expressions surrounded by $$....$$
3925              \"\\(\"    find math expressions surrounded by \\(...\\)
3926              \"\\=\\[\"    find math expressions surrounded by \\=\\[...\\]"
3927   :group 'org-latex
3928   :type 'plist)
3929
3930 (defcustom org-format-latex-signal-error t
3931   "Non-nil means signal an error when image creation of LaTeX snippets fails.
3932 When nil, just push out a message."
3933   :group 'org-latex
3934   :version "24.1"
3935   :type 'boolean)
3936
3937 (defcustom org-latex-to-mathml-jar-file nil
3938   "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3939 Use this to specify additional executable file say a jar file.
3940
3941 When using MathToWeb as the converter, specify the full-path to
3942 your mathtoweb.jar file."
3943   :group 'org-latex
3944   :version "24.1"
3945   :type '(choice
3946           (const :tag "None" nil)
3947           (file :tag "JAR file" :must-match t)))
3948
3949 (defcustom org-latex-to-mathml-convert-command nil
3950   "Command to convert LaTeX fragments to MathML.
3951 Replace format-specifiers in the command as noted below and use
3952 `shell-command' to convert LaTeX to MathML.
3953 %j:     Executable file in fully expanded form as specified by
3954         `org-latex-to-mathml-jar-file'.
3955 %I:     Input LaTeX file in fully expanded form.
3956 %i:     The latex fragment to be converted.
3957 %o:     Output MathML file.
3958
3959 This command is used by `org-create-math-formula'.
3960
3961 When using MathToWeb as the converter, set this option to
3962 \"java -jar %j -unicode -force -df %o %I\".
3963
3964 When using LaTeXML set this option to
3965 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3966   :group 'org-latex
3967   :version "24.1"
3968   :type '(choice
3969           (const :tag "None" nil)
3970           (string :tag "\nShell command")))
3971
3972 (defcustom org-latex-create-formula-image-program 'dvipng
3973   "Program to convert LaTeX fragments with.
3974
3975 dvipng          Process the LaTeX fragments to dvi file, then convert
3976                 dvi files to png files using dvipng.
3977                 This will also include processing of non-math environments.
3978 imagemagick     Convert the LaTeX fragments to pdf files and use imagemagick
3979                 to convert pdf files to png files"
3980   :group 'org-latex
3981   :version "24.1"
3982   :type '(choice
3983           (const :tag "dvipng" dvipng)
3984           (const :tag "imagemagick" imagemagick)))
3985
3986 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
3987   "Path to store latex preview images.
3988 A relative path here creates many directories relative to the
3989 processed org files paths.  An absolute path puts all preview
3990 images at the same place."
3991   :group 'org-latex
3992   :version "24.3"
3993   :type 'string)
3994
3995 (defun org-format-latex-mathml-available-p ()
3996   "Return t if `org-latex-to-mathml-convert-command' is usable."
3997   (save-match-data
3998     (when (and (boundp 'org-latex-to-mathml-convert-command)
3999                org-latex-to-mathml-convert-command)
4000       (let ((executable (car (split-string
4001                               org-latex-to-mathml-convert-command))))
4002         (when (executable-find executable)
4003           (if (string-match
4004                "%j" org-latex-to-mathml-convert-command)
4005               (file-readable-p org-latex-to-mathml-jar-file)
4006             t))))))
4007
4008 (defcustom org-format-latex-header "\\documentclass{article}
4009 \\usepackage[usenames]{color}
4010 \[PACKAGES]
4011 \[DEFAULT-PACKAGES]
4012 \\pagestyle{empty}             % do not remove
4013 % The settings below are copied from fullpage.sty
4014 \\setlength{\\textwidth}{\\paperwidth}
4015 \\addtolength{\\textwidth}{-3cm}
4016 \\setlength{\\oddsidemargin}{1.5cm}
4017 \\addtolength{\\oddsidemargin}{-2.54cm}
4018 \\setlength{\\evensidemargin}{\\oddsidemargin}
4019 \\setlength{\\textheight}{\\paperheight}
4020 \\addtolength{\\textheight}{-\\headheight}
4021 \\addtolength{\\textheight}{-\\headsep}
4022 \\addtolength{\\textheight}{-\\footskip}
4023 \\addtolength{\\textheight}{-3cm}
4024 \\setlength{\\topmargin}{1.5cm}
4025 \\addtolength{\\topmargin}{-2.54cm}"
4026   "The document header used for processing LaTeX fragments.
4027 It is imperative that this header make sure that no page number
4028 appears on the page.  The package defined in the variables
4029 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4030 will either replace the placeholder \"[PACKAGES]\" in this
4031 header, or they will be appended."
4032   :group 'org-latex
4033   :type 'string)
4034
4035 (defun org-set-packages-alist (var val)
4036   "Set the packages alist and make sure it has 3 elements per entry."
4037   (set var (mapcar (lambda (x)
4038                      (if (and (consp x) (= (length x) 2))
4039                          (list (car x) (nth 1 x) t)
4040                        x))
4041                    val)))
4042
4043 (defun org-get-packages-alist (var)
4044   "Get the packages alist and make sure it has 3 elements per entry."
4045   (mapcar (lambda (x)
4046             (if (and (consp x) (= (length x) 2))
4047                 (list (car x) (nth 1 x) t)
4048               x))
4049           (default-value var)))
4050
4051 (defcustom org-latex-default-packages-alist
4052   '(("AUTO" "inputenc"  t ("pdflatex"))
4053     ("T1"   "fontenc"   t ("pdflatex"))
4054     (""     "graphicx"  t)
4055     (""     "grffile"   t)
4056     (""     "longtable" nil)
4057     (""     "wrapfig"   nil)
4058     (""     "rotating"  nil)
4059     ("normalem" "ulem"  t)
4060     (""     "amsmath"   t)
4061     (""     "textcomp"  t)
4062     (""     "amssymb"   t)
4063     (""     "capt-of"   nil)
4064     (""     "hyperref"  nil))
4065   "Alist of default packages to be inserted in the header.
4066
4067 Change this only if one of the packages here causes an
4068 incompatibility with another package you are using.
4069
4070 The packages in this list are needed by one part or another of
4071 Org mode to function properly:
4072
4073 - inputenc, fontenc:  for basic font and character selection
4074 - graphicx: for including images
4075 - grffile: allow periods and spaces in graphics file names
4076 - longtable: For multipage tables
4077 - wrapfig: for figure placement
4078 - rotating: for sideways figures and tables
4079 - ulem: for underline and strike-through
4080 - amsmath: for subscript and superscript and math environments
4081 - textcomp, amssymb: for various symbols used
4082   for interpreting the entities in `org-entities'.  You can skip
4083   some of these packages if you don't use any of their symbols.
4084 - capt-of: for captions outside of floats
4085 - hyperref: for cross references
4086
4087 Therefore you should not modify this variable unless you know
4088 what you are doing.  The one reason to change it anyway is that
4089 you might be loading some other package that conflicts with one
4090 of the default packages.  Each element is either a cell or
4091 a string.
4092
4093 A cell is of the format
4094
4095   (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
4096
4097 If SNIPPET-FLAG is non-nil, the package also needs to be included
4098 when compiling LaTeX snippets into images for inclusion into
4099 non-LaTeX output.  COMPILERS is a list of compilers that should
4100 include the package, see `org-latex-compiler'.  If the document
4101 compiler is not in the list, and the list is non-nil, the package
4102 will not be inserted in the final document.
4103
4104 A string will be inserted as-is in the header of the document."
4105   :group 'org-latex
4106   :group 'org-export-latex
4107   :set 'org-set-packages-alist
4108   :get 'org-get-packages-alist
4109   :version "25.1"
4110   :package-version '(Org . "8.3")
4111   :type '(repeat
4112           (choice
4113            (list :tag "options/package pair"
4114                  (string :tag "options")
4115                  (string :tag "package")
4116                  (boolean :tag "Snippet"))
4117            (string :tag "A line of LaTeX"))))
4118
4119 (defcustom org-latex-packages-alist nil
4120   "Alist of packages to be inserted in every LaTeX header.
4121
4122 These will be inserted after `org-latex-default-packages-alist'.
4123 Each element is either a cell or a string.
4124
4125 A cell is of the format:
4126
4127     (\"options\" \"package\" SNIPPET-FLAG)
4128
4129 SNIPPET-FLAG, when non-nil, indicates that this package is also
4130 needed when turning LaTeX snippets into images for inclusion into
4131 non-LaTeX output.
4132
4133 A string will be inserted as-is in the header of the document.
4134
4135 Make sure that you only list packages here which:
4136
4137   - you want in every file;
4138   - do not conflict with the setup in `org-format-latex-header';
4139   - do not conflict with the default packages in
4140     `org-latex-default-packages-alist'."
4141   :group 'org-latex
4142   :group 'org-export-latex
4143   :set 'org-set-packages-alist
4144   :get 'org-get-packages-alist
4145   :type '(repeat
4146           (choice
4147            (list :tag "options/package pair"
4148                  (string :tag "options")
4149                  (string :tag "package")
4150                  (boolean :tag "Snippet"))
4151            (string :tag "A line of LaTeX"))))
4152
4153 (defgroup org-appearance nil
4154   "Settings for Org-mode appearance."
4155   :tag "Org Appearance"
4156   :group 'org)
4157
4158 (defcustom org-level-color-stars-only nil
4159   "Non-nil means fontify only the stars in each headline.
4160 When nil, the entire headline is fontified.
4161 Changing it requires restart of `font-lock-mode' to become effective
4162 also in regions already fontified."
4163   :group 'org-appearance
4164   :type 'boolean)
4165
4166 (defcustom org-hide-leading-stars nil
4167   "Non-nil means hide the first N-1 stars in a headline.
4168 This works by using the face `org-hide' for these stars.  This
4169 face is white for a light background, and black for a dark
4170 background.  You may have to customize the face `org-hide' to
4171 make this work.
4172 Changing it requires restart of `font-lock-mode' to become effective
4173 also in regions already fontified.
4174 You may also set this on a per-file basis by adding one of the following
4175 lines to the buffer:
4176
4177    #+STARTUP: hidestars
4178    #+STARTUP: showstars"
4179   :group 'org-appearance
4180   :type 'boolean)
4181
4182 (defcustom org-hidden-keywords nil
4183   "List of symbols corresponding to keywords to be hidden the org buffer.
4184 For example, a value \\='(title) for this list will make the document's title
4185 appear in the buffer without the initial #+TITLE: keyword."
4186   :group 'org-appearance
4187   :version "24.1"
4188   :type '(set (const :tag "#+AUTHOR" author)
4189               (const :tag "#+DATE" date)
4190               (const :tag "#+EMAIL" email)
4191               (const :tag "#+TITLE" title)))
4192
4193 (defcustom org-custom-properties nil
4194   "List of properties (as strings) with a special meaning.
4195 The default use of these custom properties is to let the user
4196 hide them with `org-toggle-custom-properties-visibility'."
4197   :group 'org-properties
4198   :group 'org-appearance
4199   :version "24.3"
4200   :type '(repeat (string :tag "Property Name")))
4201
4202 (defcustom org-fontify-done-headline nil
4203   "Non-nil means change the face of a headline if it is marked DONE.
4204 Normally, only the TODO/DONE keyword indicates the state of a headline.
4205 When this is non-nil, the headline after the keyword is set to the
4206 `org-headline-done' as an additional indication."
4207   :group 'org-appearance
4208   :type 'boolean)
4209
4210 (defcustom org-fontify-emphasized-text t
4211   "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4212 Changing this variable requires a restart of Emacs to take effect."
4213   :group 'org-appearance
4214   :type 'boolean)
4215
4216 (defcustom org-fontify-whole-heading-line nil
4217   "Non-nil means fontify the whole line for headings.
4218 This is useful when setting a background color for the
4219 org-level-* faces."
4220   :group 'org-appearance
4221   :type 'boolean)
4222
4223 (defcustom org-highlight-latex-and-related nil
4224   "Non-nil means highlight LaTeX related syntax in the buffer.
4225 When non nil, the value should be a list containing any of the
4226 following symbols:
4227   `latex'    Highlight LaTeX snippets and environments.
4228   `script'   Highlight subscript and superscript.
4229   `entities' Highlight entities."
4230   :group 'org-appearance
4231   :version "24.4"
4232   :package-version '(Org . "8.0")
4233   :type '(choice
4234           (const :tag "No highlighting" nil)
4235           (set :greedy t :tag "Highlight"
4236                (const :tag "LaTeX snippets and environments" latex)
4237                (const :tag "Subscript and superscript" script)
4238                (const :tag "Entities" entities))))
4239
4240 (defcustom org-hide-emphasis-markers nil
4241   "Non-nil mean font-lock should hide the emphasis marker characters."
4242   :group 'org-appearance
4243   :type 'boolean)
4244
4245 (defcustom org-hide-macro-markers nil
4246   "Non-nil mean font-lock should hide the brackets marking macro calls."
4247   :group 'org-appearance
4248   :type 'boolean)
4249
4250 (defcustom org-pretty-entities nil
4251   "Non-nil means show entities as UTF8 characters.
4252 When nil, the \\name form remains in the buffer."
4253   :group 'org-appearance
4254   :version "24.1"
4255   :type 'boolean)
4256
4257 (defcustom org-pretty-entities-include-sub-superscripts t
4258   "Non-nil means, pretty entity display includes formatting sub/superscripts."
4259   :group 'org-appearance
4260   :version "24.1"
4261   :type 'boolean)
4262
4263 (defvar org-emph-re nil
4264   "Regular expression for matching emphasis.
4265 After a match, the match groups contain these elements:
4266 0  The match of the full regular expression, including the characters
4267    before and after the proper match
4268 1  The character before the proper match, or empty at beginning of line
4269 2  The proper match, including the leading and trailing markers
4270 3  The leading marker like * or /, indicating the type of highlighting
4271 4  The text between the emphasis markers, not including the markers
4272 5  The character after the match, empty at the end of a line")
4273 (defvar org-verbatim-re nil
4274   "Regular expression for matching verbatim text.")
4275 (defvar org-emphasis-regexp-components) ; defined just below
4276 (defvar org-emphasis-alist) ; defined just below
4277 (defun org-set-emph-re (var val)
4278   "Set variable and compute the emphasis regular expression."
4279   (set var val)
4280   (when (and (boundp 'org-emphasis-alist)
4281              (boundp 'org-emphasis-regexp-components)
4282              org-emphasis-alist org-emphasis-regexp-components)
4283     (let* ((e org-emphasis-regexp-components)
4284            (pre (car e))
4285            (post (nth 1 e))
4286            (border (nth 2 e))
4287            (body (nth 3 e))
4288            (nl (nth 4 e))
4289            (body1 (concat body "*?"))
4290            (markers (mapconcat 'car org-emphasis-alist ""))
4291            (vmarkers (mapconcat
4292                       (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4293                       org-emphasis-alist "")))
4294       ;; make sure special characters appear at the right position in the class
4295       (if (string-match "\\^" markers)
4296           (setq markers (concat (replace-match "" t t markers) "^")))
4297       (if (string-match "-" markers)
4298           (setq markers (concat (replace-match "" t t markers) "-")))
4299       (if (string-match "\\^" vmarkers)
4300           (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4301       (if (string-match "-" vmarkers)
4302           (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4303       (if (> nl 0)
4304           (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4305                               (int-to-string nl) "\\}")))
4306       ;; Make the regexp
4307       (setq org-emph-re
4308             (concat "\\([" pre "]\\|^\\)"
4309                     "\\("
4310                     "\\([" markers "]\\)"
4311                     "\\("
4312                     "[^" border "]\\|"
4313                     "[^" border "]"
4314                     body1
4315                     "[^" border "]"
4316                     "\\)"
4317                     "\\3\\)"
4318                     "\\([" post "]\\|$\\)"))
4319       (setq org-verbatim-re
4320             (concat "\\([" pre "]\\|^\\)"
4321                     "\\("
4322                     "\\([" vmarkers "]\\)"
4323                     "\\("
4324                     "[^" border "]\\|"
4325                     "[^" border "]"
4326                     body1
4327                     "[^" border "]"
4328                     "\\)"
4329                     "\\3\\)"
4330                     "\\([" post  "]\\|$\\)")))))
4331
4332 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4333 ;; set this option proved cumbersome.  See this message/thread:
4334 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4335 (defvar org-emphasis-regexp-components
4336   '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n" "." 1)
4337   "Components used to build the regular expression for emphasis.
4338 This is a list with five entries.  Terminology:  In an emphasis string
4339 like \" *strong word* \", we call the initial space PREMATCH, the final
4340 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4341 and \"trong wor\" is the body.  The different components in this variable
4342 specify what is allowed/forbidden in each part:
4343
4344 pre          Chars allowed as prematch.  Beginning of line will be allowed too.
4345 post         Chars allowed as postmatch.  End of line will be allowed too.
4346 border       The chars *forbidden* as border characters.
4347 body-regexp  A regexp like \".\" to match a body character.  Don't use
4348              non-shy groups here, and don't allow newline here.
4349 newline      The maximum number of newlines allowed in an emphasis exp.
4350
4351 You need to reload Org or to restart Emacs after customizing this.")
4352
4353 (defcustom org-emphasis-alist
4354   `(("*" bold)
4355     ("/" italic)
4356     ("_" underline)
4357     ("=" org-verbatim verbatim)
4358     ("~" org-code verbatim)
4359     ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4360   "Alist of characters and faces to emphasize text.
4361 Text starting and ending with a special character will be emphasized,
4362 for example *bold*, _underlined_ and /italic/.  This variable sets the
4363 marker characters and the face to be used by font-lock for highlighting
4364 in Org-mode Emacs buffers.
4365
4366 You need to reload Org or to restart Emacs after customizing this."
4367   :group 'org-appearance
4368   :set 'org-set-emph-re
4369   :version "24.4"
4370   :package-version '(Org . "8.0")
4371   :type '(repeat
4372           (list
4373            (string :tag "Marker character")
4374            (choice
4375             (face :tag "Font-lock-face")
4376             (plist :tag "Face property list"))
4377            (option (const verbatim)))))
4378
4379 (defvar org-protecting-blocks '("src" "example" "export")
4380   "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4381 This is needed for font-lock setup.")
4382
4383 ;;; Functions and variables from their packages
4384 ;;  Declared here to avoid compiler warnings
4385
4386 ;; XEmacs only
4387 (defvar outline-mode-menu-heading)
4388 (defvar outline-mode-menu-show)
4389 (defvar outline-mode-menu-hide)
4390 (defvar zmacs-regions) ; XEmacs regions
4391
4392 ;; Emacs only
4393 (defvar mark-active)
4394
4395 ;; Various packages
4396 (declare-function calc-eval "calc" (str &optional separator &rest args))
4397 (declare-function calendar-forward-day "cal-move" (arg))
4398 (declare-function calendar-goto-date "cal-move" (date))
4399 (declare-function calendar-goto-today "cal-move" ())
4400 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4401 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4402 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4403 (declare-function cdlatex-tab "ext:cdlatex" ())
4404 (declare-function dired-get-filename
4405                   "dired"
4406                   (&optional localp no-error-if-not-filep))
4407 (declare-function iswitchb-read-buffer
4408                   "iswitchb"
4409                   (prompt &optional default require-match start matches-set))
4410 (declare-function org-agenda-change-all-lines
4411                   "org-agenda"
4412                   (newhead hdmarker &optional fixface just-this))
4413 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4414                   "org-agenda"
4415                   (&optional end))
4416 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4417 (declare-function org-agenda-format-item
4418                   "org-agenda"
4419                   (extra txt &optional level category tags dotime noprefix
4420                          remove-re habitp))
4421 (declare-function org-agenda-maybe-redo "org-agenda" ())
4422 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4423 (declare-function org-agenda-save-markers-for-cut-and-paste
4424                   "org-agenda"
4425                   (beg end))
4426 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4427 (declare-function org-agenda-skip "org-agenda" ())
4428 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4429 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4430 (declare-function org-indent-mode "org-indent" (&optional arg))
4431 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4432 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4433 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4434 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4435 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4436 (declare-function parse-time-string "parse-time" (string))
4437 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4438 (declare-function table--at-cell-p
4439                   "table"
4440                   (position &optional object at-column))
4441
4442 (defvar align-mode-rules-list)
4443 (defvar calc-embedded-close-formula)
4444 (defvar calc-embedded-open-formula)
4445 (defvar calc-embedded-open-mode)
4446 (defvar font-lock-unfontify-region-function)
4447 (defvar iswitchb-temp-buflist)
4448 (defvar org-agenda-tags-todo-honor-ignore-options)
4449 (defvar remember-data-file)
4450 (defvar texmathp-why)
4451
4452 ;;;###autoload
4453 (defun turn-on-orgtbl ()
4454   "Unconditionally turn on `orgtbl-mode'."
4455   (require 'org-table)
4456   (orgtbl-mode 1))
4457
4458 (defun org-at-table-p (&optional table-type)
4459   "Non-nil if the cursor is inside an Org table.
4460 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4461 If `org-enable-table-editor' is nil, return nil unconditionally."
4462   (and
4463    org-enable-table-editor
4464    (save-excursion
4465      (beginning-of-line)
4466      (org-looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4467    (or (not (derived-mode-p 'org-mode))
4468        (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4469          (and e (or table-type (eq (org-element-property :type e) 'org)))))))
4470 (define-obsolete-function-alias 'org-table-p 'org-at-table-p "Org 9.0")
4471
4472 (defun org-at-table.el-p ()
4473   "Non-nil when point is at a table.el table."
4474   (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4475        (let ((element (org-element-at-point)))
4476          (and (eq (org-element-type element) 'table)
4477               (eq (org-element-property :type element) 'table.el)))))
4478
4479 (defun org-table-recognize-table.el ()
4480   "If there is a table.el table nearby, recognize it and move into it."
4481   (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
4482     (beginning-of-line)
4483     (unless (or (looking-at org-table-dataline-regexp)
4484                 (not (looking-at org-table1-hline-regexp)))
4485       (forward-line)
4486       (when (looking-at org-table-any-border-regexp)
4487         (forward-line -2)))
4488     (if (re-search-forward "|" (org-table-end t) t)
4489         (progn
4490           (require 'table)
4491           (if (table--at-cell-p (point)) t
4492             (message "recognizing table.el table...")
4493             (table-recognize-table)
4494             (message "recognizing table.el table...done")))
4495       (error "This should not happen"))))
4496 ;;; This function is not used by org core since commit 6d1e3082, Feb 2010
4497 (make-obsolete 'org-table-recognize-table.el
4498                "please notify the org mailing list if you use this function."
4499                "Org 9.0")
4500
4501 (defun org-at-table-hline-p ()
4502   "Non-nil when point is inside a hline in a table.
4503 Assume point is already in a table.  If `org-enable-table-editor'
4504 is nil, return nil unconditionally."
4505   (and org-enable-table-editor
4506        (save-excursion
4507          (beginning-of-line)
4508          (looking-at org-table-hline-regexp))))
4509
4510 (defun org-table-map-tables (function &optional quietly)
4511   "Apply FUNCTION to the start of all tables in the buffer."
4512   (save-excursion
4513     (save-restriction
4514       (widen)
4515       (goto-char (point-min))
4516       (while (re-search-forward org-table-any-line-regexp nil t)
4517         (unless quietly
4518           (message "Mapping tables: %d%%"
4519                    (floor (* 100.0 (point)) (buffer-size))))
4520         (beginning-of-line 1)
4521         (when (and (looking-at org-table-line-regexp)
4522                    ;; Exclude tables in src/example/verbatim/clocktable blocks
4523                    (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4524           (save-excursion (funcall function))
4525           (or (looking-at org-table-line-regexp)
4526               (forward-char 1)))
4527         (re-search-forward org-table-any-border-regexp nil 1))))
4528   (unless quietly (message "Mapping tables: done")))
4529
4530 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4531 (declare-function org-clock-update-mode-line "org-clock" ())
4532 (declare-function org-resolve-clocks "org-clock"
4533                   (&optional also-non-dangling-p prompt last-valid))
4534
4535 (defun org-at-TBLFM-p (&optional pos)
4536   "Non-nil when point (or POS) is in #+TBLFM line."
4537   (save-excursion
4538     (goto-char (or pos (point)))
4539     (beginning-of-line)
4540     (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4541          (eq (org-element-type (org-element-at-point)) 'table))))
4542
4543 (defvar org-clock-start-time)
4544 (defvar org-clock-marker (make-marker)
4545   "Marker recording the last clock-in.")
4546 (defvar org-clock-hd-marker (make-marker)
4547   "Marker recording the last clock-in, but the headline position.")
4548 (defvar org-clock-heading ""
4549   "The heading of the current clock entry.")
4550 (defun org-clock-is-active ()
4551   "Return the buffer where the clock is currently running.
4552 Return nil if no clock is running."
4553   (marker-buffer org-clock-marker))
4554
4555 (defun org-check-running-clock ()
4556   "Check if the current buffer contains the running clock.
4557 If yes, offer to stop it and to save the buffer with the changes."
4558   (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4559              (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4560                                (buffer-name))))
4561     (org-clock-out)
4562     (when (y-or-n-p "Save changed buffer?")
4563       (save-buffer))))
4564
4565 (defun org-clocktable-try-shift (dir n)
4566   "Check if this line starts a clock table, if yes, shift the time block."
4567   (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4568     (org-clocktable-shift dir n)))
4569
4570 ;;;###autoload
4571 (defun org-clock-persistence-insinuate ()
4572   "Set up hooks for clock persistence."
4573   (require 'org-clock)
4574   (add-hook 'org-mode-hook 'org-clock-load)
4575   (add-hook 'kill-emacs-hook 'org-clock-save))
4576
4577 (defgroup org-archive nil
4578   "Options concerning archiving in Org-mode."
4579   :tag "Org Archive"
4580   :group 'org-structure)
4581
4582 (defcustom org-archive-location "%s_archive::"
4583   "The location where subtrees should be archived.
4584
4585 The value of this variable is a string, consisting of two parts,
4586 separated by a double-colon.  The first part is a filename and
4587 the second part is a headline.
4588
4589 When the filename is omitted, archiving happens in the same file.
4590 %s in the filename will be replaced by the current file
4591 name (without the directory part).  Archiving to a different file
4592 is useful to keep archived entries from contributing to the
4593 Org-mode Agenda.
4594
4595 The archived entries will be filed as subtrees of the specified
4596 headline.  When the headline is omitted, the subtrees are simply
4597 filed away at the end of the file, as top-level entries.  Also in
4598 the heading you can use %s to represent the file name, this can be
4599 useful when using the same archive for a number of different files.
4600
4601 Here are a few examples:
4602 \"%s_archive::\"
4603         If the current file is Projects.org, archive in file
4604         Projects.org_archive, as top-level trees.  This is the default.
4605
4606 \"::* Archived Tasks\"
4607         Archive in the current file, under the top-level headline
4608         \"* Archived Tasks\".
4609
4610 \"~/org/archive.org::\"
4611         Archive in file ~/org/archive.org (absolute path), as top-level trees.
4612
4613 \"~/org/archive.org::* From %s\"
4614         Archive in file ~/org/archive.org (absolute path), under headlines
4615         \"From FILENAME\" where file name is the current file name.
4616
4617 \"~/org/datetree.org::datetree/* Finished Tasks\"
4618         The \"datetree/\" string is special, signifying to archive
4619         items to the datetree.  Items are placed in either the CLOSED
4620         date of the item, or the current date if there is no CLOSED date.
4621         The heading will be a subentry to the current date.  There doesn't
4622         need to be a heading, but there always needs to be a slash after
4623         datetree.  For example, to store archived items directly in the
4624         datetree, use \"~/org/datetree.org::datetree/\".
4625
4626 \"basement::** Finished Tasks\"
4627         Archive in file ./basement (relative path), as level 3 trees
4628         below the level 2 heading \"** Finished Tasks\".
4629
4630 You may set this option on a per-file basis by adding to the buffer a
4631 line like
4632
4633 #+ARCHIVE: basement::** Finished Tasks
4634
4635 You may also define it locally for a subtree by setting an ARCHIVE property
4636 in the entry.  If such a property is found in an entry, or anywhere up
4637 the hierarchy, it will be used."
4638   :group 'org-archive
4639   :type 'string)
4640
4641 (defcustom org-agenda-skip-archived-trees t
4642   "Non-nil means the agenda will skip any items located in archived trees.
4643 An archived tree is a tree marked with the tag ARCHIVE.  The use of this
4644 variable is no longer recommended, you should leave it at the value t.
4645 Instead, use the key `v' to cycle the archives-mode in the agenda."
4646   :group 'org-archive
4647   :group 'org-agenda-skip
4648   :type 'boolean)
4649
4650 (defcustom org-columns-skip-archived-trees t
4651   "Non-nil means ignore archived trees when creating column view."
4652   :group 'org-archive
4653   :group 'org-properties
4654   :type 'boolean)
4655
4656 (defcustom org-cycle-open-archived-trees nil
4657   "Non-nil means `org-cycle' will open archived trees.
4658 An archived tree is a tree marked with the tag ARCHIVE.
4659 When nil, archived trees will stay folded.  You can still open them with
4660 normal outline commands like `show-all', but not with the cycling commands."
4661   :group 'org-archive
4662   :group 'org-cycle
4663   :type 'boolean)
4664
4665 (defcustom org-sparse-tree-open-archived-trees nil
4666   "Non-nil means sparse tree construction shows matches in archived trees.
4667 When nil, matches in these trees are highlighted, but the trees are kept in
4668 collapsed state."
4669   :group 'org-archive
4670   :group 'org-sparse-trees
4671   :type 'boolean)
4672
4673 (defcustom org-sparse-tree-default-date-type nil
4674   "The default date type when building a sparse tree.
4675 When this is nil, a date is a scheduled or a deadline timestamp.
4676 Otherwise, these types are allowed:
4677
4678         all: all timestamps
4679      active: only active timestamps (<...>)
4680    inactive: only inactive timestamps ([...])
4681   scheduled: only scheduled timestamps
4682    deadline: only deadline timestamps"
4683   :type '(choice (const :tag "Scheduled or deadline" nil)
4684                  (const :tag "All timestamps" all)
4685                  (const :tag "Only active timestamps" active)
4686                  (const :tag "Only inactive timestamps" inactive)
4687                  (const :tag "Only scheduled timestamps" scheduled)
4688                  (const :tag "Only deadline timestamps" deadline)
4689                  (const :tag "Only closed timestamps" closed))
4690   :version "25.1"
4691   :package-version '(Org . "8.3")
4692   :group 'org-sparse-trees)
4693
4694 (defun org-cycle-hide-archived-subtrees (state)
4695   "Re-hide all archived subtrees after a visibility state change."
4696   (when (and (not org-cycle-open-archived-trees)
4697              (not (memq state '(overview folded))))
4698     (save-excursion
4699       (let* ((globalp (memq state '(contents all)))
4700              (beg (if globalp (point-min) (point)))
4701              (end (if globalp (point-max) (org-end-of-subtree t))))
4702         (org-hide-archived-subtrees beg end)
4703         (goto-char beg)
4704         (when (looking-at-p (concat ".*:" org-archive-tag ":"))
4705           (message "%s" (substitute-command-keys
4706                          "Subtree is archived and stays closed.  Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4707
4708 (defun org-force-cycle-archived ()
4709   "Cycle subtree even if it is archived."
4710   (interactive)
4711   (setq this-command 'org-cycle)
4712   (let ((org-cycle-open-archived-trees t))
4713     (call-interactively 'org-cycle)))
4714
4715 (defun org-hide-archived-subtrees (beg end)
4716   "Re-hide all archived subtrees after a visibility state change."
4717   (org-with-wide-buffer
4718    (let ((case-fold-search nil)
4719          (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4720      (goto-char beg)
4721      ;; Include headline point is currently on.
4722      (beginning-of-line)
4723      (while (and (< (point) end) (re-search-forward re end t))
4724        (when (member org-archive-tag (org-get-tags))
4725          (org-flag-subtree t)
4726          (org-end-of-subtree t))))))
4727
4728 (declare-function outline-end-of-heading "outline" ())
4729 (declare-function outline-flag-region "outline" (from to flag))
4730 (defun org-flag-subtree (flag)
4731   (save-excursion
4732     (org-back-to-heading t)
4733     (outline-end-of-heading)
4734     (outline-flag-region (point)
4735                          (progn (org-end-of-subtree t) (point))
4736                          flag)))
4737
4738 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4739
4740 ;; Declare Column View Code
4741
4742 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4743 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4744 (declare-function org-columns-compute "org-colview" (property))
4745
4746 ;; Declare ID code
4747
4748 (declare-function org-id-store-link "org-id")
4749 (declare-function org-id-locations-load "org-id")
4750 (declare-function org-id-locations-save "org-id")
4751 (defvar org-id-track-globally)
4752
4753 ;;; Variables for pre-computed regular expressions, all buffer local
4754
4755 (defvar-local org-todo-regexp nil
4756   "Matches any of the TODO state keywords.")
4757 (defvar-local org-not-done-regexp nil
4758   "Matches any of the TODO state keywords except the last one.")
4759 (defvar-local org-not-done-heading-regexp nil
4760   "Matches a TODO headline that is not done.")
4761 (defvar-local org-todo-line-regexp nil
4762   "Matches a headline and puts TODO state into group 2 if present.")
4763 (defvar-local org-complex-heading-regexp nil
4764   "Matches a headline and puts everything into groups:
4765 group 1: the stars
4766 group 2: The todo keyword, maybe
4767 group 3: Priority cookie
4768 group 4: True headline
4769 group 5: Tags")
4770 (defvar-local org-complex-heading-regexp-format nil
4771   "Printf format to make regexp to match an exact headline.
4772 This regexp will match the headline of any node which has the
4773 exact headline text that is put into the format, but may have any
4774 TODO state, priority and tags.")
4775 (defvar-local org-todo-line-tags-regexp nil
4776   "Matches a headline and puts TODO state into group 2 if present.
4777 Also put tags into group 4 if tags are present.")
4778
4779 (defconst org-plain-time-of-day-regexp
4780   (concat
4781    "\\(\\<[012]?[0-9]"
4782    "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4783    "\\(--?"
4784    "\\(\\<[012]?[0-9]"
4785    "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4786    "\\)?")
4787   "Regular expression to match a plain time or time range.
4788 Examples:  11:45 or 8am-13:15 or 2:45-2:45pm.  After a match, the following
4789 groups carry important information:
4790 0  the full match
4791 1  the first time, range or not
4792 8  the second time, if it is a range.")
4793
4794 (defconst org-plain-time-extension-regexp
4795   (concat
4796    "\\(\\<[012]?[0-9]"
4797    "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4798    "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4799   "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4800 Examples:  11:45 or 8am-13:15 or 2:45-2:45pm.  After a match, the following
4801 groups carry important information:
4802 0  the full match
4803 7  hours of duration
4804 9  minutes of duration")
4805
4806 (defconst org-stamp-time-of-day-regexp
4807   (concat
4808    "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4809    "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4810    "\\(--?"
4811    "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4812   "Regular expression to match a timestamp time or time range.
4813 After a match, the following groups carry important information:
4814 0  the full match
4815 1  date plus weekday, for back referencing to make sure both times are on the same day
4816 2  the first time, range or not
4817 4  the second time, if it is a range.")
4818
4819 (defconst org-startup-options
4820   '(("fold" org-startup-folded t)
4821     ("overview" org-startup-folded t)
4822     ("nofold" org-startup-folded nil)
4823     ("showall" org-startup-folded nil)
4824     ("showeverything" org-startup-folded showeverything)
4825     ("content" org-startup-folded content)
4826     ("indent" org-startup-indented t)
4827     ("noindent" org-startup-indented nil)
4828     ("hidestars" org-hide-leading-stars t)
4829     ("showstars" org-hide-leading-stars nil)
4830     ("odd" org-odd-levels-only t)
4831     ("oddeven" org-odd-levels-only nil)
4832     ("align" org-startup-align-all-tables t)
4833     ("noalign" org-startup-align-all-tables nil)
4834     ("inlineimages" org-startup-with-inline-images t)
4835     ("noinlineimages" org-startup-with-inline-images nil)
4836     ("latexpreview" org-startup-with-latex-preview t)
4837     ("nolatexpreview" org-startup-with-latex-preview nil)
4838     ("customtime" org-display-custom-times t)
4839     ("logdone" org-log-done time)
4840     ("lognotedone" org-log-done note)
4841     ("nologdone" org-log-done nil)
4842     ("lognoteclock-out" org-log-note-clock-out t)
4843     ("nolognoteclock-out" org-log-note-clock-out nil)
4844     ("logrepeat" org-log-repeat state)
4845     ("lognoterepeat" org-log-repeat note)
4846     ("logdrawer" org-log-into-drawer t)
4847     ("nologdrawer" org-log-into-drawer nil)
4848     ("logstatesreversed" org-log-states-order-reversed t)
4849     ("nologstatesreversed" org-log-states-order-reversed nil)
4850     ("nologrepeat" org-log-repeat nil)
4851     ("logreschedule" org-log-reschedule time)
4852     ("lognotereschedule" org-log-reschedule note)
4853     ("nologreschedule" org-log-reschedule nil)
4854     ("logredeadline" org-log-redeadline time)
4855     ("lognoteredeadline" org-log-redeadline note)
4856     ("nologredeadline" org-log-redeadline nil)
4857     ("logrefile" org-log-refile time)
4858     ("lognoterefile" org-log-refile note)
4859     ("nologrefile" org-log-refile nil)
4860     ("fninline" org-footnote-define-inline t)
4861     ("nofninline" org-footnote-define-inline nil)
4862     ("fnlocal" org-footnote-section nil)
4863     ("fnauto" org-footnote-auto-label t)
4864     ("fnprompt" org-footnote-auto-label nil)
4865     ("fnconfirm" org-footnote-auto-label confirm)
4866     ("fnplain" org-footnote-auto-label plain)
4867     ("fnadjust" org-footnote-auto-adjust t)
4868     ("nofnadjust" org-footnote-auto-adjust nil)
4869     ("constcgs" constants-unit-system cgs)
4870     ("constSI" constants-unit-system SI)
4871     ("noptag" org-tag-persistent-alist nil)
4872     ("hideblocks" org-hide-block-startup t)
4873     ("nohideblocks" org-hide-block-startup nil)
4874     ("beamer" org-startup-with-beamer-mode t)
4875     ("entitiespretty" org-pretty-entities t)
4876     ("entitiesplain" org-pretty-entities nil))
4877   "Variable associated with STARTUP options for org-mode.
4878 Each element is a list of three items: the startup options (as written
4879 in the #+STARTUP line), the corresponding variable, and the value to set
4880 this variable to if the option is found.  An optional forth element PUSH
4881 means to push this value onto the list in the variable.")
4882
4883 (defcustom org-group-tags t
4884   "When non-nil (the default), use group tags.
4885 This can be turned on/off through `org-toggle-tags-groups'."
4886   :group 'org-tags
4887   :group 'org-startup
4888   :type 'boolean)
4889
4890 (defvar org-inhibit-startup nil)        ; Dynamically-scoped param.
4891
4892 (defun org-toggle-tags-groups ()
4893   "Toggle support for group tags.
4894 Support for group tags is controlled by the option
4895 `org-group-tags', which is non-nil by default."
4896   (interactive)
4897   (setq org-group-tags (not org-group-tags))
4898   (cond ((and (derived-mode-p 'org-agenda-mode)
4899               org-group-tags)
4900          (org-agenda-redo))
4901         ((derived-mode-p 'org-mode)
4902          (let ((org-inhibit-startup t)) (org-mode))))
4903   (message "Groups tags support has been turned %s"
4904            (if org-group-tags "on" "off")))
4905
4906 (defun org-set-regexps-and-options (&optional tags-only)
4907   "Precompute regular expressions used in the current buffer.
4908 When optional argument TAGS-ONLY is non-nil, only compute tags
4909 related expressions."
4910   (when (derived-mode-p 'org-mode)
4911     (let ((alist (org--setup-collect-keywords
4912                   (org-make-options-regexp
4913                    (append '("FILETAGS" "TAGS" "SETUPFILE")
4914                            (and (not tags-only)
4915                                 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4916                                   "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4917                                   "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4918       (org--setup-process-tags
4919        (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4920       (unless tags-only
4921         ;; File properties.
4922         (setq-local org-file-properties (cdr (assq 'property alist)))
4923         ;; Archive location.
4924         (let ((archive (cdr (assq 'archive alist))))
4925           (when archive (setq-local org-archive-location archive)))
4926         ;; Category.
4927         (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4928           (when cat
4929             (setq-local org-category (intern cat))
4930             (setq-local org-file-properties
4931                         (org--update-property-plist
4932                          "CATEGORY" cat org-file-properties))))
4933         ;; Columns.
4934         (let ((column (cdr (assq 'columns alist))))
4935           (when column (setq-local org-columns-default-format column)))
4936         ;; Constants.
4937         (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4938         ;; Link abbreviations.
4939         (let ((links (cdr (assq 'link alist))))
4940           (when links (setq org-link-abbrev-alist-local (nreverse links))))
4941         ;; Priorities.
4942         (let ((priorities (cdr (assq 'priorities alist))))
4943           (when priorities
4944             (setq-local org-highest-priority (nth 0 priorities))
4945             (setq-local org-lowest-priority (nth 1 priorities))
4946             (setq-local org-default-priority (nth 2 priorities))))
4947         ;; Scripts.
4948         (let ((scripts (assq 'scripts alist)))
4949           (when scripts
4950             (setq-local org-use-sub-superscripts (cdr scripts))))
4951         ;; Startup options.
4952         (let ((startup (cdr (assq 'startup alist))))
4953           (dolist (option startup)
4954             (let ((entry (assoc-string option org-startup-options t)))
4955               (when entry
4956                 (let ((var (nth 1 entry))
4957                       (val (nth 2 entry)))
4958                   (if (not (nth 3 entry)) (set (make-local-variable var) val)
4959                     (unless (listp (symbol-value var))
4960                       (set (make-local-variable var) nil))
4961                     (add-to-list var val)))))))
4962         ;; TODO keywords.
4963         (setq-local org-todo-kwd-alist nil)
4964         (setq-local org-todo-key-alist nil)
4965         (setq-local org-todo-key-trigger nil)
4966         (setq-local org-todo-keywords-1 nil)
4967         (setq-local org-done-keywords nil)
4968         (setq-local org-todo-heads nil)
4969         (setq-local org-todo-sets nil)
4970         (setq-local org-todo-log-states nil)
4971         (let ((todo-sequences
4972                (or (nreverse (cdr (assq 'todo alist)))
4973                    (let ((d (default-value 'org-todo-keywords)))
4974                      (if (not (stringp (car d))) d
4975                        ;; XXX: Backward compatibility code.
4976                        (list (cons org-todo-interpretation d)))))))
4977           (dolist (sequence todo-sequences)
4978             (let* ((sequence (or (run-hook-with-args-until-success
4979                                   'org-todo-setup-filter-hook sequence)
4980                                  sequence))
4981                    (sequence-type (car sequence))
4982                    (keywords (cdr sequence))
4983                    (sep (member "|" keywords))
4984                    names alist)
4985               (dolist (k (remove "|" keywords))
4986                 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
4987                                       k)
4988                   (error "Invalid TODO keyword %s" k))
4989                 (let ((name (match-string 1 k))
4990                       (key (match-string 2 k))
4991                       (log (org-extract-log-state-settings k)))
4992                   (push name names)
4993                   (push (cons name (and key (string-to-char key))) alist)
4994                   (when log (push log org-todo-