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