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