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