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