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