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