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