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