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