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