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