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