New option `org-properties-postprocess-alist'.
[org-mode.git] / lisp / org.el
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.7
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
17
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 ;; GNU General Public License for more details.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text.  Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured.  Visibility cycling and structure editing
36 ;; help to work with the tree.  Tables are easily created with a built-in
37 ;; table editor.  Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling.  It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects.  For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file.  It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;;   http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file.  The
56 ;; distribution also contains a PDF version of it.  At the homepage of
57 ;; Org-mode, you can read the same text online as HTML.  There is also an
58 ;; excellent reference card made by Philip Rooke.  This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
65
66 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
67 (defvar org-table-formula-constants-local nil
68   "Local version of `org-table-formula-constants'.")
69 (make-variable-buffer-local 'org-table-formula-constants-local)
70
71 ;;;; Require other packages
72
73 (eval-when-compile
74   (require 'cl)
75   (require 'gnus-sum))
76
77 (require 'calendar)
78
79 ;; Emacs 22 calendar compatibility:  Make sure the new variables are available
80 (when (fboundp 'defvaralias)
81   (unless (boundp 'calendar-view-holidays-initially-flag)
82     (defvaralias 'calendar-view-holidays-initially-flag
83       'view-calendar-holidays-initially))
84   (unless (boundp 'calendar-view-diary-initially-flag)
85     (defvaralias 'calendar-view-diary-initially-flag
86       'view-diary-entries-initially))
87   (unless (boundp 'diary-fancy-buffer)
88     (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
89
90 (require 'outline) (require 'noutline)
91 ;; Other stuff we need.
92 (require 'time-date)
93 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
94 (require 'easymenu)
95 (require 'overlay)
96
97 (require 'org-macs)
98 (require 'org-entities)
99 (require 'org-compat)
100 (require 'org-faces)
101 (require 'org-list)
102 (require 'org-pcomplete)
103 (require 'org-src)
104 (require 'org-footnote)
105
106 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
107 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
108 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
110 (declare-function org-at-clock-log-p "org-clock" ())
111 (declare-function org-clock-timestamps-up "org-clock" ())
112 (declare-function org-clock-timestamps-down "org-clock" ())
113
114 ;; babel
115 (require 'ob)
116 (require 'ob-table)
117 (require 'ob-lob)
118 (require 'ob-ref)
119 (require 'ob-tangle)
120 (require 'ob-comint)
121 (require 'ob-keys)
122
123 ;; load languages based on value of `org-babel-load-languages'
124 (defvar org-babel-load-languages)
125 ;;;###autoload
126 (defun org-babel-do-load-languages (sym value)
127   "Load the languages defined in `org-babel-load-languages'."
128   (set-default sym value)
129   (mapc (lambda (pair)
130           (let ((active (cdr pair)) (lang (symbol-name (car pair))))
131             (if active
132                 (progn
133                   (require (intern (concat "ob-" lang))))
134               (progn
135                 (funcall 'fmakunbound
136                          (intern (concat "org-babel-execute:" lang)))
137                 (funcall 'fmakunbound
138                          (intern (concat "org-babel-expand-body:" lang)))))))
139         org-babel-load-languages))
140
141 (defcustom org-babel-load-languages '((emacs-lisp . t))
142   "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes.  When a language is
146 \"loaded\", then code blocks in that language can be evaluated
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding.  By default only Emacs Lisp (which has no
151 requirements) is loaded."
152   :group 'org-babel
153   :set 'org-babel-do-load-languages
154   :type '(alist :tag "Babel Languages"
155                 :key-type
156                 (choice
157                  (const :tag "Awk" awk)
158                  (const :tag "C" C)
159                  (const :tag "R" R)
160                  (const :tag "Asymptote" asymptote)
161                  (const :tag "Calc" calc)
162                  (const :tag "Clojure" clojure)
163                  (const :tag "CSS" css)
164                  (const :tag "Ditaa" ditaa)
165                  (const :tag "Dot" dot)
166                  (const :tag "Emacs Lisp" emacs-lisp)
167                  (const :tag "Gnuplot" gnuplot)
168                  (const :tag "Haskell" haskell)
169                  (const :tag "Java" java)
170                  (const :tag "Javascript" js)
171                  (const :tag "Latex" latex)
172                  (const :tag "Ledger" ledger)
173                  (const :tag "Lilypond" lilypond)
174                  (const :tag "Maxima" maxima)
175                  (const :tag "Matlab" matlab)
176                  (const :tag "Mscgen" mscgen)
177                  (const :tag "Ocaml" ocaml)
178                  (const :tag "Octave" octave)
179                  (const :tag "Org" org)
180                  (const :tag "Perl" perl)
181                  (const :tag "PlantUML" plantuml)
182                  (const :tag "Python" python)
183                  (const :tag "Ruby" ruby)
184                  (const :tag "Sass" sass)
185                  (const :tag "Scheme" scheme)
186                  (const :tag "Screen" screen)
187                  (const :tag "Shell Script" sh)
188                  (const :tag "Sql" sql)
189                  (const :tag "Sqlite" sqlite))
190                 :value-type (boolean :tag "Activate" :value t)))
191
192 ;;;; Customization variables
193 (defcustom org-clone-delete-id nil
194   "Remove ID property of clones of a subtree.
195 When non-nil, clones of a subtree don't inherit the ID property.
196 Otherwise they inherit the ID property with a new unique
197 identifier."
198   :type 'boolean
199   :group 'org-id)
200
201 ;;; Version
202
203 (defconst org-version "7.7"
204   "The version number of the file org.el.")
205
206 (defun org-version (&optional here)
207   "Show the org-mode version in the echo area.
208 With prefix arg HERE, insert it at point."
209   (interactive "P")
210   (let* ((origin default-directory)
211          (version org-version)
212          (git-version)
213          (dir (concat (file-name-directory (locate-library "org")) "../" )))
214     (when (and (file-exists-p (expand-file-name ".git" dir))
215                (executable-find "git"))
216       (unwind-protect
217           (progn
218             (cd dir)
219             (when (eql 0 (shell-command "git describe --abbrev=4 HEAD"))
220               (with-current-buffer "*Shell Command Output*"
221                 (goto-char (point-min))
222                 (setq git-version (buffer-substring (point) (point-at-eol))))
223               (subst-char-in-string ?- ?. git-version t)
224               (when (string-match "\\S-"
225                                   (shell-command-to-string
226                                    "git diff-index --name-only HEAD --"))
227                 (setq git-version (concat git-version ".dirty")))
228               (setq version (concat version " (" git-version ")"))))
229         (cd origin)))
230     (setq version (format "Org-mode version %s" version))
231     (if here (insert version))
232     (message version)))
233
234 ;;; Compatibility constants
235
236 ;;; The custom variables
237
238 (defgroup org nil
239   "Outline-based notes management and organizer."
240   :tag "Org"
241   :group 'outlines
242   :group 'calendar)
243
244 (defcustom org-mode-hook nil
245   "Mode hook for Org-mode, run after the mode was turned on."
246   :group 'org
247   :type 'hook)
248
249 (defcustom org-load-hook nil
250   "Hook that is run after org.el has been loaded."
251   :group 'org
252   :type 'hook)
253
254 (defcustom org-log-buffer-setup-hook nil
255   "Hook that is run after an Org log buffer is created."
256   :group 'org
257   :type 'hook)
258
259 (defvar org-modules)  ; defined below
260 (defvar org-modules-loaded nil
261   "Have the modules been loaded already?")
262
263 (defun org-load-modules-maybe (&optional force)
264   "Load all extensions listed in `org-modules'."
265   (when (or force (not org-modules-loaded))
266     (mapc (lambda (ext)
267             (condition-case nil (require ext)
268               (error (message "Problems while trying to load feature `%s'" ext))))
269           org-modules)
270     (setq org-modules-loaded t)))
271
272 (defun org-set-modules (var value)
273   "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
274   (set var value)
275   (when (featurep 'org)
276     (org-load-modules-maybe 'force)))
277
278 (when (org-bound-and-true-p org-modules)
279   (let ((a (member 'org-infojs org-modules)))
280     (and a (setcar a 'org-jsinfo))))
281
282 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
283   "Modules that should always be loaded together with org.el.
284 If a description starts with <C>, the file is not part of Emacs
285 and loading it will require that you have downloaded and properly installed
286 the org-mode distribution.
287
288 You can also use this system to load external packages (i.e. neither Org
289 core modules, nor modules from the CONTRIB directory).  Just add symbols
290 to the end of the list.  If the package is called org-xyz.el, then you need
291 to add the symbol `xyz', and the package must have a call to
292
293    (provide 'org-xyz)"
294   :group 'org
295   :set 'org-set-modules
296   :type
297   '(set :greedy t
298         (const :tag "   bbdb:              Links to BBDB entries" org-bbdb)
299         (const :tag "   bibtex:            Links to BibTeX entries" org-bibtex)
300         (const :tag "   crypt:             Encryption of subtrees" org-crypt)
301         (const :tag "   ctags:             Access to Emacs tags with links" org-ctags)
302         (const :tag "   docview:           Links to doc-view buffers" org-docview)
303         (const :tag "   gnus:              Links to GNUS folders/messages" org-gnus)
304         (const :tag "   id:                Global IDs for identifying entries" org-id)
305         (const :tag "   info:              Links to Info nodes" org-info)
306         (const :tag "   jsinfo:            Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
307         (const :tag "   habit:             Track your consistency with habits" org-habit)
308         (const :tag "   inlinetask:        Tasks independent of outline hierarchy" org-inlinetask)
309         (const :tag "   irc:               Links to IRC/ERC chat sessions" org-irc)
310         (const :tag "   mac-message:       Links to messages in Apple Mail" org-mac-message)
311         (const :tag "   mew                Links to Mew folders/messages" org-mew)
312         (const :tag "   mhe:               Links to MHE folders/messages" org-mhe)
313         (const :tag "   protocol:          Intercept calls from emacsclient" org-protocol)
314         (const :tag "   rmail:             Links to RMAIL folders/messages" org-rmail)
315         (const :tag "   special-blocks:    Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
316         (const :tag "   vm:                Links to VM folders/messages" org-vm)
317         (const :tag "   wl:                Links to Wanderlust folders/messages" org-wl)
318         (const :tag "   w3m:               Special cut/paste from w3m to Org-mode." org-w3m)
319         (const :tag "   mouse:             Additional mouse support" org-mouse)
320         (const :tag "   TaskJuggler:       Export tasks to a TaskJuggler project" org-taskjuggler)
321
322         (const :tag "C  annotate-file:     Annotate a file with org syntax" org-annotate-file)
323         (const :tag "C  bookmark:          Org-mode links to bookmarks" org-bookmark)
324         (const :tag "C  checklist:         Extra functions for checklists in repeated tasks" org-checklist)
325         (const :tag "C  choose:            Use TODO keywords to mark decisions states" org-choose)
326         (const :tag "C  collector:         Collect properties into tables" org-collector)
327         (const :tag "C  depend:            TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
328         (const :tag "C  drill:             Flashcards and spaced repetition for Org-mode" org-drill)
329         (const :tag "C  elisp-symbol:      Org-mode links to emacs-lisp symbols" org-elisp-symbol)
330         (const :tag "C  eshell             Support for links to working directories in eshell" org-eshell)
331         (const :tag "C  eval:              Include command output as text" org-eval)
332         (const :tag "C  eval-light:        Evaluate inbuffer-code on demand" org-eval-light)
333         (const :tag "C  expiry:            Expiry mechanism for Org-mode entries" org-expiry)
334         (const :tag "C  exp-bibtex:        Export citations using BibTeX" org-exp-bibtex)
335         (const :tag "C  git-link:          Provide org links to specific file version" org-git-link)
336         (const :tag "C  interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
337
338         (const :tag "C  invoice:           Help manage client invoices in Org-mode" org-invoice)
339
340         (const :tag "C  jira:              Add a jira:ticket protocol to Org-mode" org-jira)
341         (const :tag "C  learn:             SuperMemo's incremental learning algorithm" org-learn)
342         (const :tag "C  mairix:            Hook mairix search into Org-mode for different MUAs" org-mairix)
343         (const :tag "C  notmuch:           Provide org links to notmuch searches or messages" org-notmuch)
344         (const :tag "C  mac-iCal           Imports events from iCal.app to the Emacs diary" org-mac-iCal)
345         (const :tag "C  mac-link-grabber   Grab links and URLs from various Mac applications" org-mac-link-grabber)
346         (const :tag "C  man:               Support for links to manpages in Org-mode" org-man)
347         (const :tag "C  mtags:             Support for muse-like tags" org-mtags)
348         (const :tag "C  odt:               OpenDocumentText exporter for Org-mode" org-odt)
349         (const :tag "C  panel:             Simple routines for us with bad memory" org-panel)
350         (const :tag "C  registry:          A registry for Org-mode links" org-registry)
351         (const :tag "C  org2rem:           Convert org appointments into reminders" org2rem)
352         (const :tag "C  screen:            Visit screen sessions through Org-mode links" org-screen)
353         (const :tag "C  secretary:         Team management with org-mode" org-secretary)
354         (const :tag "C  sqlinsert:         Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
355         (const :tag "C  toc:               Table of contents for Org-mode buffer" org-toc)
356         (const :tag "C  track:             Keep up with Org-mode development" org-track)
357         (const :tag "C  velocity           Something like Notational Velocity for Org" org-velocity)
358         (const :tag "C  wikinodes:         CamelCase wiki-like links" org-wikinodes)
359         (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
360
361 (defcustom org-support-shift-select nil
362   "Non-nil means make shift-cursor commands select text when possible.
363
364 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
365 selecting a region, or enlarge regions started in this way.
366 In Org-mode, in special contexts, these same keys are used for other
367 purposes, important enough to compete with shift selection.  Org tries
368 to balance these needs by supporting `shift-select-mode' outside these
369 special contexts, under control of this variable.
370
371 The default of this variable is nil, to avoid confusing behavior.  Shifted
372 cursor keys will then execute Org commands in the following contexts:
373 - on a headline, changing TODO state (left/right) and priority (up/down)
374 - on a time stamp, changing the time
375 - in a plain list item, changing the bullet type
376 - in a property definition line, switching between allowed values
377 - in the BEGIN line of a clock table (changing the time block).
378 Outside these contexts, the commands will throw an error.
379
380 When this variable is t and the cursor is not in a special context,
381 Org-mode will support shift-selection for making and enlarging regions.
382 To make this more effective, the bullet cycling will no longer happen
383 anywhere in an item line, but only if the cursor is exactly on the bullet.
384
385 If you set this variable to the symbol `always', then the keys
386 will not be special in headlines, property lines, and item lines, to make
387 shift selection work there as well.  If this is what you want, you can
388 use the following alternative commands: `C-c C-t' and `C-c ,' to
389 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
390 TODO sets, `C-c -' to cycle item bullet types, and properties can be
391 edited by hand or in column view.
392
393 However, when the cursor is on a timestamp, shift-cursor commands
394 will still edit the time stamp - this is just too good to give up.
395
396 XEmacs user should have this variable set to nil, because shift-select-mode
397 is Emacs 23 only."
398   :group 'org
399   :type '(choice
400           (const :tag "Never" nil)
401           (const :tag "When outside special context" t)
402           (const :tag "Everywhere except timestamps" always)))
403
404 (defgroup org-startup nil
405   "Options concerning startup of Org-mode."
406   :tag "Org Startup"
407   :group 'org)
408
409 (defcustom org-startup-folded t
410   "Non-nil means entering Org-mode will switch to OVERVIEW.
411 This can also be configured on a per-file basis by adding one of
412 the following lines anywhere in the buffer:
413
414    #+STARTUP: fold              (or `overview', this is equivalent)
415    #+STARTUP: nofold            (or `showall', this is equivalent)
416    #+STARTUP: content
417    #+STARTUP: showeverything"
418   :group 'org-startup
419   :type '(choice
420           (const :tag "nofold: show all" nil)
421           (const :tag "fold: overview" t)
422           (const :tag "content: all headlines" content)
423           (const :tag "show everything, even drawers" showeverything)))
424
425 (defcustom org-startup-truncated t
426   "Non-nil means entering Org-mode will set `truncate-lines'.
427 This is useful since some lines containing links can be very long and
428 uninteresting.  Also tables look terrible when wrapped."
429   :group 'org-startup
430   :type 'boolean)
431
432 (defcustom org-startup-indented nil
433   "Non-nil means turn on `org-indent-mode' on startup.
434 This can also be configured on a per-file basis by adding one of
435 the following lines anywhere in the buffer:
436
437    #+STARTUP: indent
438    #+STARTUP: noindent"
439   :group 'org-structure
440   :type '(choice
441           (const :tag "Not" nil)
442           (const :tag "Globally (slow on startup in large files)" t)))
443
444 (defcustom org-use-sub-superscripts t
445   "Non-nil means interpret \"_\" and \"^\" for export.
446 When this option is turned on, you can use TeX-like syntax for sub- and
447 superscripts.  Several characters after \"_\" or \"^\" will be
448 considered as a single item - so grouping with {} is normally not
449 needed.  For example, the following things will be parsed as single
450 sub- or superscripts.
451
452  10^24   or   10^tau     several digits will be considered 1 item.
453  10^-12  or   10^-tau    a leading sign with digits or a word
454  x^2-y^3                 will be read as x^2 - y^3, because items are
455                          terminated by almost any nonword/nondigit char.
456  x_{i^2} or   x^(2-i)    braces or parenthesis do grouping.
457
458 Still, ambiguity is possible - so when in doubt use {} to enclose the
459 sub/superscript.  If you set this variable to the symbol `{}',
460 the braces are *required* in order to trigger interpretations as
461 sub/superscript.  This can be helpful in documents that need \"_\"
462 frequently in plain text.
463
464 Not all export backends support this, but HTML does.
465
466 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
467   :group 'org-startup
468   :group 'org-export-translation
469   :type '(choice
470           (const :tag "Always interpret" t)
471           (const :tag "Only with braces" {})
472           (const :tag "Never interpret" nil)))
473
474 (if (fboundp 'defvaralias)
475     (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
476
477
478 (defcustom org-startup-with-beamer-mode nil
479   "Non-nil means turn on `org-beamer-mode' on startup.
480 This can also be configured on a per-file basis by adding one of
481 the following lines anywhere in the buffer:
482
483    #+STARTUP: beamer"
484   :group 'org-startup
485   :type 'boolean)
486
487 (defcustom org-startup-align-all-tables nil
488   "Non-nil means align all tables when visiting a file.
489 This is useful when the column width in tables is forced with <N> cookies
490 in table fields.  Such tables will look correct only after the first re-align.
491 This can also be configured on a per-file basis by adding one of
492 the following lines anywhere in the buffer:
493    #+STARTUP: align
494    #+STARTUP: noalign"
495   :group 'org-startup
496   :type 'boolean)
497
498 (defcustom org-startup-with-inline-images nil
499   "Non-nil means show inline images when loading a new Org file.
500 This can also be configured on a per-file basis by adding one of
501 the following lines anywhere in the buffer:
502    #+STARTUP: inlineimages
503    #+STARTUP: noinlineimages"
504   :group 'org-startup
505   :type 'boolean)
506
507 (defcustom org-insert-mode-line-in-empty-file nil
508   "Non-nil means insert the first line setting Org-mode in empty files.
509 When the function `org-mode' is called interactively in an empty file, this
510 normally means that the file name does not automatically trigger Org-mode.
511 To ensure that the file will always be in Org-mode in the future, a
512 line enforcing Org-mode will be inserted into the buffer, if this option
513 has been set."
514   :group 'org-startup
515   :type 'boolean)
516
517 (defcustom org-replace-disputed-keys nil
518   "Non-nil means use alternative key bindings for some keys.
519 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
520 These keys are also used by other packages like shift-selection-mode'
521 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
522 If you want to use Org-mode together with one of these other modes,
523 or more generally if you would like to move some Org-mode commands to
524 other keys, set this variable and configure the keys with the variable
525 `org-disputed-keys'.
526
527 This option is only relevant at load-time of Org-mode, and must be set
528 *before* org.el is loaded.  Changing it requires a restart of Emacs to
529 become effective."
530   :group 'org-startup
531   :type 'boolean)
532
533 (defcustom org-use-extra-keys nil
534   "Non-nil means use extra key sequence definitions for certain commands.
535 This happens automatically if you run XEmacs or if `window-system'
536 is nil.  This variable lets you do the same manually.  You must
537 set it before loading org.
538
539 Example: on Carbon Emacs 22 running graphically, with an external
540 keyboard on a Powerbook, the default way of setting M-left might
541 not work for either Alt or ESC.  Setting this variable will make
542 it work for ESC."
543   :group 'org-startup
544   :type 'boolean)
545
546 (if (fboundp 'defvaralias)
547     (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
548
549 (defcustom org-disputed-keys
550   '(([(shift up)]               . [(meta p)])
551     ([(shift down)]             . [(meta n)])
552     ([(shift left)]             . [(meta -)])
553     ([(shift right)]            . [(meta +)])
554     ([(control shift right)]    . [(meta shift +)])
555     ([(control shift left)]     . [(meta shift -)]))
556   "Keys for which Org-mode and other modes compete.
557 This is an alist, cars are the default keys, second element specifies
558 the alternative to use when `org-replace-disputed-keys' is t.
559
560 Keys can be specified in any syntax supported by `define-key'.
561 The value of this option takes effect only at Org-mode's startup,
562 therefore you'll have to restart Emacs to apply it after changing."
563   :group 'org-startup
564   :type 'alist)
565
566 (defun org-key (key)
567   "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
568 Or return the original if not disputed.
569 Also apply the translations defined in `org-xemacs-key-equivalents'."
570   (when org-replace-disputed-keys
571     (let* ((nkey (key-description key))
572            (x (org-find-if (lambda (x)
573                              (equal (key-description (car x)) nkey))
574                            org-disputed-keys)))
575       (setq key (if x (cdr x) key))))
576   (when (featurep 'xemacs)
577     (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
578   key)
579
580 (defun org-find-if (predicate seq)
581   (catch 'exit
582     (while seq
583       (if (funcall predicate (car seq))
584           (throw 'exit (car seq))
585         (pop seq)))))
586
587 (defun org-defkey (keymap key def)
588   "Define a key, possibly translated, as returned by `org-key'."
589   (define-key keymap (org-key key) def))
590
591 (defcustom org-ellipsis nil
592   "The ellipsis to use in the Org-mode outline.
593 When nil, just use the standard three dots.  When a string, use that instead,
594 When a face, use the standard 3 dots, but with the specified face.
595 The change affects only Org-mode (which will then use its own display table).
596 Changing this requires executing `M-x org-mode' in a buffer to become
597 effective."
598   :group 'org-startup
599   :type '(choice (const :tag "Default" nil)
600                  (face :tag "Face" :value org-warning)
601                  (string :tag "String" :value "...#")))
602
603 (defvar org-display-table nil
604   "The display table for org-mode, in case `org-ellipsis' is non-nil.")
605
606 (defgroup org-keywords nil
607   "Keywords in Org-mode."
608   :tag "Org Keywords"
609   :group 'org)
610
611 (defcustom org-deadline-string "DEADLINE:"
612   "String to mark deadline entries.
613 A deadline is this string, followed by a time stamp.  Should be a word,
614 terminated by a colon.  You can insert a schedule keyword and
615 a timestamp with \\[org-deadline].
616 Changes become only effective after restarting Emacs."
617   :group 'org-keywords
618   :type 'string)
619
620 (defcustom org-scheduled-string "SCHEDULED:"
621   "String to mark scheduled TODO entries.
622 A schedule is this string, followed by a time stamp.  Should be a word,
623 terminated by a colon.  You can insert a schedule keyword and
624 a timestamp with \\[org-schedule].
625 Changes become only effective after restarting Emacs."
626   :group 'org-keywords
627   :type 'string)
628
629 (defcustom org-closed-string "CLOSED:"
630   "String used as the prefix for timestamps logging closing a TODO entry."
631   :group 'org-keywords
632   :type 'string)
633
634 (defcustom org-clock-string "CLOCK:"
635   "String used as prefix for timestamps clocking work hours on an item."
636   :group 'org-keywords
637   :type 'string)
638
639 (defcustom org-comment-string "COMMENT"
640   "Entries starting with this keyword will never be exported.
641 An entry can be toggled between COMMENT and normal with
642 \\[org-toggle-comment].
643 Changes become only effective after restarting Emacs."
644   :group 'org-keywords
645   :type 'string)
646
647 (defcustom org-quote-string "QUOTE"
648   "Entries starting with this keyword will be exported in fixed-width font.
649 Quoting applies only to the text in the entry following the headline, and does
650 not extend beyond the next headline, even if that is lower level.
651 An entry can be toggled between QUOTE and normal with
652 \\[org-toggle-fixed-width-section]."
653   :group 'org-keywords
654   :type 'string)
655
656 (defconst org-repeat-re
657   "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)"
658   "Regular expression for specifying repeated events.
659 After a match, group 1 contains the repeat expression.")
660
661 (defgroup org-structure nil
662   "Options concerning the general structure of Org-mode files."
663   :tag "Org Structure"
664   :group 'org)
665
666 (defgroup org-reveal-location nil
667   "Options about how to make context of a location visible."
668   :tag "Org Reveal Location"
669   :group 'org-structure)
670
671 (defconst org-context-choice
672   '(choice
673     (const :tag "Always" t)
674     (const :tag "Never" nil)
675     (repeat :greedy t :tag "Individual contexts"
676             (cons
677              (choice :tag "Context"
678                      (const agenda)
679                      (const org-goto)
680                      (const occur-tree)
681                      (const tags-tree)
682                      (const link-search)
683                      (const mark-goto)
684                      (const bookmark-jump)
685                      (const isearch)
686                      (const default))
687              (boolean))))
688   "Contexts for the reveal options.")
689
690 (defcustom org-show-hierarchy-above '((default . t))
691   "Non-nil means show full hierarchy when revealing a location.
692 Org-mode often shows locations in an org-mode file which might have
693 been invisible before.  When this is set, the hierarchy of headings
694 above the exposed location is shown.
695 Turning this off for example for sparse trees makes them very compact.
696 Instead of t, this can also be an alist specifying this option for different
697 contexts.  Valid contexts are
698   agenda         when exposing an entry from the agenda
699   org-goto       when using the command `org-goto' on key C-c C-j
700   occur-tree     when using the command `org-occur' on key C-c /
701   tags-tree      when constructing a sparse tree based on tags matches
702   link-search    when exposing search matches associated with a link
703   mark-goto      when exposing the jump goal of a mark
704   bookmark-jump  when exposing a bookmark location
705   isearch        when exiting from an incremental search
706   default        default for all contexts not set explicitly"
707   :group 'org-reveal-location
708   :type org-context-choice)
709
710 (defcustom org-show-following-heading '((default . nil))
711   "Non-nil means show following heading when revealing a location.
712 Org-mode often shows locations in an org-mode file which might have
713 been invisible before.  When this is set, the heading following the
714 match is shown.
715 Turning this off for example for sparse trees makes them very compact,
716 but makes it harder to edit the location of the match.  In such a case,
717 use the command \\[org-reveal] to show more context.
718 Instead of t, this can also be an alist specifying this option for different
719 contexts.  See `org-show-hierarchy-above' for valid contexts."
720   :group 'org-reveal-location
721   :type org-context-choice)
722
723 (defcustom org-show-siblings '((default . nil) (isearch t))
724   "Non-nil means show all sibling heading when revealing a location.
725 Org-mode often shows locations in an org-mode file which might have
726 been invisible before.  When this is set, the sibling of the current entry
727 heading are all made visible.  If `org-show-hierarchy-above' is t,
728 the same happens on each level of the hierarchy above the current entry.
729
730 By default this is on for the isearch context, off for all other contexts.
731 Turning this off for example for sparse trees makes them very compact,
732 but makes it harder to edit the location of the match.  In such a case,
733 use the command \\[org-reveal] to show more context.
734 Instead of t, this can also be an alist specifying this option for different
735 contexts.  See `org-show-hierarchy-above' for valid contexts."
736   :group 'org-reveal-location
737   :type org-context-choice)
738
739 (defcustom org-show-entry-below '((default . nil))
740   "Non-nil means show the entry below a headline when revealing a location.
741 Org-mode often shows locations in an org-mode file which might have
742 been invisible before.  When this is set, the text below the headline that is
743 exposed is also shown.
744
745 By default this is off for all contexts.
746 Instead of t, this can also be an alist specifying this option for different
747 contexts.  See `org-show-hierarchy-above' for valid contexts."
748   :group 'org-reveal-location
749   :type org-context-choice)
750
751 (defcustom org-indirect-buffer-display 'other-window
752   "How should indirect tree buffers be displayed?
753 This applies to indirect buffers created with the commands
754 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
755 Valid values are:
756 current-window   Display in the current window
757 other-window     Just display in another window.
758 dedicated-frame  Create one new frame, and re-use it each time.
759 new-frame        Make a new frame each time.  Note that in this case
760                  previously-made indirect buffers are kept, and you need to
761                  kill these buffers yourself."
762   :group 'org-structure
763   :group 'org-agenda-windows
764   :type '(choice
765           (const :tag "In current window" current-window)
766           (const :tag "In current frame, other window" other-window)
767           (const :tag "Each time a new frame" new-frame)
768           (const :tag "One dedicated frame" dedicated-frame)))
769
770 (defcustom org-use-speed-commands nil
771   "Non-nil means activate single letter commands at beginning of a headline.
772 This may also be a function to test for appropriate locations where speed
773 commands should be active."
774   :group 'org-structure
775   :type '(choice
776           (const :tag "Never" nil)
777           (const :tag "At beginning of headline stars" t)
778           (function)))
779
780 (defcustom org-speed-commands-user nil
781     "Alist of additional speed commands.
782 This list will be checked before `org-speed-commands-default'
783 when the variable `org-use-speed-commands' is non-nil
784 and when the cursor is at the beginning of a headline.
785 The car if each entry is a string with a single letter, which must
786 be assigned to `self-insert-command' in the global map.
787 The cdr is either a command to be called interactively, a function
788 to be called, or a form to be evaluated.
789 An entry that is just a list with a single string will be interpreted
790 as a descriptive headline that will be added when listing the speed
791 commands in the Help buffer using the `?' speed command."
792     :group 'org-structure
793     :type '(repeat :value ("k" . ignore)
794             (choice :value ("k" . ignore)
795              (list :tag "Descriptive Headline" (string :tag "Headline"))
796              (cons :tag "Letter and Command"
797               (string :tag "Command letter")
798               (choice
799                (function)
800                (sexp))))))
801
802 (defgroup org-cycle nil
803   "Options concerning visibility cycling in Org-mode."
804   :tag "Org Cycle"
805   :group 'org-structure)
806
807 (defcustom org-cycle-skip-children-state-if-no-children t
808   "Non-nil means skip CHILDREN state in entries that don't have any."
809   :group 'org-cycle
810   :type 'boolean)
811
812 (defcustom org-cycle-max-level nil
813   "Maximum level which should still be subject to visibility cycling.
814 Levels higher than this will, for cycling, be treated as text, not a headline.
815 When `org-odd-levels-only' is set, a value of N in this variable actually
816 means 2N-1 stars as the limiting headline.
817 When nil, cycle all levels.
818 Note that the limiting level of cycling is also influenced by
819 `org-inlinetask-min-level'.  When `org-cycle-max-level' is not set but
820 `org-inlinetask-min-level' is, cycling will be limited to levels one less
821 than its value."
822   :group 'org-cycle
823   :type '(choice
824           (const :tag "No limit" nil)
825           (integer :tag "Maximum level")))
826
827 (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
828   "Names of drawers.  Drawers are not opened by cycling on the headline above.
829 Drawers only open with a TAB on the drawer line itself.  A drawer looks like
830 this:
831    :DRAWERNAME:
832    .....
833    :END:
834 The drawer \"PROPERTIES\" is special for capturing properties through
835 the property API.
836
837 Drawers can be defined on the per-file basis with a line like:
838
839 #+DRAWERS: HIDDEN STATE PROPERTIES"
840   :group 'org-structure
841   :group 'org-cycle
842   :type '(repeat (string :tag "Drawer Name")))
843
844 (defcustom org-hide-block-startup nil
845   "Non-nil means entering Org-mode will fold all blocks.
846 This can also be set in on a per-file basis with
847
848 #+STARTUP: hideblocks
849 #+STARTUP: showblocks"
850   :group 'org-startup
851   :group 'org-cycle
852   :type 'boolean)
853
854 (defcustom org-cycle-global-at-bob nil
855   "Cycle globally if cursor is at beginning of buffer and not at a headline.
856 This makes it possible to do global cycling without having to use S-TAB or
857 \\[universal-argument] TAB.  For this special case to work, the first line \
858 of the buffer
859 must not be a headline - it may be empty or some other text.  When used in
860 this way, `org-cycle-hook' is disables temporarily, to make sure the
861 cursor stays at the beginning of the buffer.
862 When this option is nil, don't do anything special at the beginning
863 of the buffer."
864   :group 'org-cycle
865   :type 'boolean)
866
867 (defcustom org-cycle-level-after-item/entry-creation t
868   "Non-nil means cycle entry level or item indentation in new empty entries.
869
870 When the cursor is at the end of an empty headline, i.e with only stars
871 and maybe a TODO keyword, TAB will then switch the entry to become a child,
872 and then all possible ancestor states, before returning to the original state.
873 This makes data entry extremely fast:  M-RET to create a new headline,
874 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
875
876 When the cursor is at the end of an empty plain list item, one TAB will
877 make it a subitem, two or more tabs will back up to make this an item
878 higher up in the item hierarchy."
879   :group 'org-cycle
880   :type 'boolean)
881
882 (defcustom org-cycle-emulate-tab t
883   "Where should `org-cycle' emulate TAB.
884 nil         Never
885 white       Only in completely white lines
886 whitestart  Only at the beginning of lines, before the first non-white char
887 t           Everywhere except in headlines
888 exc-hl-bol  Everywhere except at the start of a headline
889 If TAB is used in a place where it does not emulate TAB, the current subtree
890 visibility is cycled."
891   :group 'org-cycle
892   :type '(choice (const :tag "Never" nil)
893                  (const :tag "Only in completely white lines" white)
894                  (const :tag "Before first char in a line" whitestart)
895                  (const :tag "Everywhere except in headlines" t)
896                  (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
897                  ))
898
899 (defcustom org-cycle-separator-lines 2
900   "Number of empty lines needed to keep an empty line between collapsed trees.
901 If you leave an empty line between the end of a subtree and the following
902 headline, this empty line is hidden when the subtree is folded.
903 Org-mode will leave (exactly) one empty line visible if the number of
904 empty lines is equal or larger to the number given in this variable.
905 So the default 2 means at least 2 empty lines after the end of a subtree
906 are needed to produce free space between a collapsed subtree and the
907 following headline.
908
909 If the number is negative, and the number of empty lines is at least -N,
910 all empty lines are shown.
911
912 Special case: when 0, never leave empty lines in collapsed view."
913   :group 'org-cycle
914   :type 'integer)
915 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
916
917 (defcustom org-pre-cycle-hook nil
918   "Hook that is run before visibility cycling is happening.
919 The function(s) in this hook must accept a single argument which indicates
920 the new state that will be set right after running this hook.  The
921 argument is a symbol.  Before a global state change, it can have the values
922 `overview', `content', or `all'.  Before a local state change, it can have
923 the values `folded', `children', or `subtree'."
924   :group 'org-cycle
925   :type 'hook)
926
927 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
928                             org-cycle-hide-drawers
929                             org-cycle-show-empty-lines
930                             org-optimize-window-after-visibility-change)
931   "Hook that is run after `org-cycle' has changed the buffer visibility.
932 The function(s) in this hook must accept a single argument which indicates
933 the new state that was set by the most recent `org-cycle' command.  The
934 argument is a symbol.  After a global state change, it can have the values
935 `overview', `content', or `all'.  After a local state change, it can have
936 the values `folded', `children', or `subtree'."
937   :group 'org-cycle
938   :type 'hook)
939
940 (defgroup org-edit-structure nil
941   "Options concerning structure editing in Org-mode."
942   :tag "Org Edit Structure"
943   :group 'org-structure)
944
945 (defcustom org-odd-levels-only nil
946   "Non-nil means skip even levels and only use odd levels for the outline.
947 This has the effect that two stars are being added/taken away in
948 promotion/demotion commands.  It also influences how levels are
949 handled by the exporters.
950 Changing it requires restart of `font-lock-mode' to become effective
951 for fontification also in regions already fontified.
952 You may also set this on a per-file basis by adding one of the following
953 lines to the buffer:
954
955    #+STARTUP: odd
956    #+STARTUP: oddeven"
957   :group 'org-edit-structure
958   :group 'org-appearance
959   :type 'boolean)
960
961 (defcustom org-adapt-indentation t
962   "Non-nil means adapt indentation to outline node level.
963
964 When this variable is set, Org assumes that you write outlines by
965 indenting text in each node to align with the headline (after the stars).
966 The following issues are influenced by this variable:
967
968 - When this is set and the *entire* text in an entry is indented, the
969   indentation is increased by one space in a demotion command, and
970   decreased by one in a promotion command.  If any line in the entry
971   body starts with text at column 0, indentation is not changed at all.
972
973 - Property drawers and planning information is inserted indented when
974   this variable s set.  When nil, they will not be indented.
975
976 - TAB indents a line relative to context.  The lines below a headline
977   will be indented when this variable is set.
978
979 Note that this is all about true indentation, by adding and removing
980 space characters.  See also `org-indent.el' which does level-dependent
981 indentation in a virtual way, i.e. at display time in Emacs."
982   :group 'org-edit-structure
983   :type 'boolean)
984
985 (defcustom org-special-ctrl-a/e nil
986   "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
987
988 When t, `C-a' will bring back the cursor to the beginning of the
989 headline text, i.e. after the stars and after a possible TODO keyword.
990 In an item, this will be the position after the bullet.
991 When the cursor is already at that position, another `C-a' will bring
992 it to the beginning of the line.
993
994 `C-e' will jump to the end of the headline, ignoring the presence of tags
995 in the headline.  A second `C-e' will then jump to the true end of the
996 line, after any tags.  This also means that, when this variable is
997 non-nil, `C-e' also will never jump beyond the end of the heading of a
998 folded section, i.e. not after the ellipses.
999
1000 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1001 going to the true line boundary first.  Only a directly following, identical
1002 keypress will bring the cursor to the special positions.
1003
1004 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1005 set separately."
1006   :group 'org-edit-structure
1007   :type '(choice
1008           (const :tag "off" nil)
1009           (const :tag "on: after stars/bullet and before tags first" t)
1010           (const :tag "reversed: true line boundary first" reversed)
1011           (cons :tag "Set C-a and C-e separately"
1012                 (choice :tag "Special C-a"
1013                         (const :tag "off" nil)
1014                         (const :tag "on: after  stars/bullet first" t)
1015                         (const :tag "reversed: before stars/bullet first" reversed))
1016                 (choice :tag "Special C-e"
1017                         (const :tag "off" nil)
1018                         (const :tag "on: before tags first" t)
1019                         (const :tag "reversed: after tags first" reversed)))))
1020 (if (fboundp 'defvaralias)
1021     (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
1022
1023 (defcustom org-special-ctrl-k nil
1024   "Non-nil means `C-k' will behave specially in headlines.
1025 When nil, `C-k' will call the default `kill-line' command.
1026 When t, the following will happen while the cursor is in the headline:
1027
1028 - When the cursor is at the beginning of a headline, kill the entire
1029   line and possible the folded subtree below the line.
1030 - When in the middle of the headline text, kill the headline up to the tags.
1031 - When after the headline text, kill the tags."
1032   :group 'org-edit-structure
1033   :type 'boolean)
1034
1035 (defcustom org-ctrl-k-protect-subtree nil
1036   "Non-nil means, do not delete a hidden subtree with C-k.
1037 When set to the symbol `error', simply throw an error when C-k is
1038 used to kill (part-of) a headline that has hidden text behind it.
1039 Any other non-nil value will result in a query to the user, if it is
1040 OK to kill that hidden subtree.  When nil, kill without remorse."
1041   :group 'org-edit-structure
1042   :type '(choice
1043           (const :tag "Do not protect hidden subtrees" nil)
1044           (const :tag "Protect hidden subtrees with a security query" t)
1045           (const :tag "Never kill a hidden subtree with C-k" error)))
1046
1047 (defcustom org-yank-folded-subtrees t
1048   "Non-nil means when yanking subtrees, fold them.
1049 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1050 it starts with a heading and all other headings in it are either children
1051 or siblings, then fold all the subtrees.  However, do this only if no
1052 text after the yank would be swallowed into a folded tree by this action."
1053   :group 'org-edit-structure
1054   :type 'boolean)
1055
1056 (defcustom org-yank-adjusted-subtrees nil
1057   "Non-nil means when yanking subtrees, adjust the level.
1058 With this setting, `org-paste-subtree' is used to insert the subtree, see
1059 this function for details."
1060   :group 'org-edit-structure
1061   :type 'boolean)
1062
1063 (defcustom org-M-RET-may-split-line '((default . t))
1064   "Non-nil means M-RET will split the line at the cursor position.
1065 When nil, it will go to the end of the line before making a
1066 new line.
1067 You may also set this option in a different way for different
1068 contexts.  Valid contexts are:
1069
1070 headline  when creating a new headline
1071 item      when creating a new item
1072 table     in a table field
1073 default   the value to be used for all contexts not explicitly
1074           customized"
1075   :group 'org-structure
1076   :group 'org-table
1077   :type '(choice
1078           (const :tag "Always" t)
1079           (const :tag "Never" nil)
1080           (repeat :greedy t :tag "Individual contexts"
1081                   (cons
1082                    (choice :tag "Context"
1083                            (const headline)
1084                            (const item)
1085                            (const table)
1086                            (const default))
1087                    (boolean)))))
1088
1089
1090 (defcustom org-insert-heading-respect-content nil
1091   "Non-nil means insert new headings after the current subtree.
1092 When nil, the new heading is created directly after the current line.
1093 The commands \\[org-insert-heading-respect-content] and
1094 \\[org-insert-todo-heading-respect-content] turn this variable on
1095 for the duration of the command."
1096   :group 'org-structure
1097   :type 'boolean)
1098
1099 (defcustom org-blank-before-new-entry '((heading . auto)
1100                                         (plain-list-item . auto))
1101   "Should `org-insert-heading' leave a blank line before new heading/item?
1102 The value is an alist, with `heading' and `plain-list-item' as CAR,
1103 and a boolean flag as CDR.  The cdr may also be the symbol `auto', in
1104 which case Org will look at the surrounding headings/items and try to
1105 make an intelligent decision whether to insert a blank line or not.
1106
1107 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1108 set, the setting here is ignored and no empty line is inserted, to avoid
1109 breaking the list structure."
1110   :group 'org-edit-structure
1111   :type '(list
1112           (cons (const heading)
1113                 (choice (const :tag "Never" nil)
1114                         (const :tag "Always" t)
1115                         (const :tag "Auto" auto)))
1116           (cons (const plain-list-item)
1117                 (choice (const :tag "Never" nil)
1118                         (const :tag "Always" t)
1119                         (const :tag "Auto" auto)))))
1120
1121 (defcustom org-insert-heading-hook nil
1122   "Hook being run after inserting a new heading."
1123   :group 'org-edit-structure
1124   :type 'hook)
1125
1126 (defcustom org-enable-fixed-width-editor t
1127   "Non-nil means lines starting with \":\" are treated as fixed-width.
1128 This currently only means they are never auto-wrapped.
1129 When nil, such lines will be treated like ordinary lines.
1130 See also the QUOTE keyword."
1131   :group 'org-edit-structure
1132   :type 'boolean)
1133
1134 (defcustom org-goto-auto-isearch t
1135   "Non-nil means typing characters in `org-goto' starts incremental search."
1136   :group 'org-edit-structure
1137   :type 'boolean)
1138
1139 (defgroup org-sparse-trees nil
1140   "Options concerning sparse trees in Org-mode."
1141   :tag "Org Sparse Trees"
1142   :group 'org-structure)
1143
1144 (defcustom org-highlight-sparse-tree-matches t
1145   "Non-nil means highlight all matches that define a sparse tree.
1146 The highlights will automatically disappear the next time the buffer is
1147 changed by an edit command."
1148   :group 'org-sparse-trees
1149   :type 'boolean)
1150
1151 (defcustom org-remove-highlights-with-change t
1152   "Non-nil means any change to the buffer will remove temporary highlights.
1153 Such highlights are created by `org-occur' and `org-clock-display'.
1154 When nil, `C-c C-c needs to be used to get rid of the highlights.
1155 The highlights created by `org-preview-latex-fragment' always need
1156 `C-c C-c' to be removed."
1157   :group 'org-sparse-trees
1158   :group 'org-time
1159   :type 'boolean)
1160
1161
1162 (defcustom org-occur-hook '(org-first-headline-recenter)
1163   "Hook that is run after `org-occur' has constructed a sparse tree.
1164 This can be used to recenter the window to show as much of the structure
1165 as possible."
1166   :group 'org-sparse-trees
1167   :type 'hook)
1168
1169 (defgroup org-imenu-and-speedbar nil
1170   "Options concerning imenu and speedbar in Org-mode."
1171   :tag "Org Imenu and Speedbar"
1172   :group 'org-structure)
1173
1174 (defcustom org-imenu-depth 2
1175   "The maximum level for Imenu access to Org-mode headlines.
1176 This also applied for speedbar access."
1177   :group 'org-imenu-and-speedbar
1178   :type 'integer)
1179
1180 (defgroup org-table nil
1181   "Options concerning tables in Org-mode."
1182   :tag "Org Table"
1183   :group 'org)
1184
1185 (defcustom org-enable-table-editor 'optimized
1186   "Non-nil means lines starting with \"|\" are handled by the table editor.
1187 When nil, such lines will be treated like ordinary lines.
1188
1189 When equal to the symbol `optimized', the table editor will be optimized to
1190 do the following:
1191 - Automatic overwrite mode in front of whitespace in table fields.
1192   This makes the structure of the table stay in tact as long as the edited
1193   field does not exceed the column width.
1194 - Minimize the number of realigns.  Normally, the table is aligned each time
1195   TAB or RET are pressed to move to another field.  With optimization this
1196   happens only if changes to a field might have changed the column width.
1197 Optimization requires replacing the functions `self-insert-command',
1198 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1199 slight (in fact: unnoticeable) speed impact for normal typing.  Org-mode is
1200 very good at guessing when a re-align will be necessary, but you can always
1201 force one with \\[org-ctrl-c-ctrl-c].
1202
1203 If you would like to use the optimized version in Org-mode, but the
1204 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1205
1206 This variable can be used to turn on and off the table editor during a session,
1207 but in order to toggle optimization, a restart is required.
1208
1209 See also the variable `org-table-auto-blank-field'."
1210   :group 'org-table
1211   :type '(choice
1212           (const :tag "off" nil)
1213           (const :tag "on" t)
1214           (const :tag "on, optimized" optimized)))
1215
1216 (defcustom org-self-insert-cluster-for-undo t
1217   "Non-nil means cluster self-insert commands for undo when possible.
1218 If this is set, then, like in the Emacs command loop, 20 consecutive
1219 characters will be undone together.
1220 This is configurable, because there is some impact on typing performance."
1221   :group 'org-table
1222   :type 'boolean)
1223
1224 (defcustom org-table-tab-recognizes-table.el t
1225   "Non-nil means TAB will automatically notice a table.el table.
1226 When it sees such a table, it moves point into it and - if necessary -
1227 calls `table-recognize-table'."
1228   :group 'org-table-editing
1229   :type 'boolean)
1230
1231 (defgroup org-link nil
1232   "Options concerning links in Org-mode."
1233   :tag "Org Link"
1234   :group 'org)
1235
1236 (defvar org-link-abbrev-alist-local nil
1237   "Buffer-local version of `org-link-abbrev-alist', which see.
1238 The value of this is taken from the #+LINK lines.")
1239 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1240
1241 (defcustom org-link-abbrev-alist nil
1242   "Alist of link abbreviations.
1243 The car of each element is a string, to be replaced at the start of a link.
1244 The cdrs are replacement values, like (\"linkkey\" . REPLACE).  Abbreviated
1245 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1246
1247      [[linkkey:tag][description]]
1248
1249 The 'linkkey' must be a word word, starting with a letter, followed
1250 by letters, numbers, '-' or '_'.
1251
1252 If REPLACE is a string, the tag will simply be appended to create the link.
1253 If the string contains \"%s\", the tag will be inserted there.  Alternatively,
1254 the placeholder \"%h\" will cause a url-encoded version of the tag to
1255 be inserted at that point (see the function `url-hexify-string').
1256
1257 REPLACE may also be a function that will be called with the tag as the
1258 only argument to create the link, which should be returned as a string.
1259
1260 See the manual for examples."
1261   :group 'org-link
1262   :type '(repeat
1263           (cons
1264            (string :tag "Protocol")
1265            (choice
1266             (string :tag "Format")
1267             (function)))))
1268
1269 (defcustom org-descriptive-links t
1270   "Non-nil means hide link part and only show description of bracket links.
1271 Bracket links are like [[link][description]].  This variable sets the initial
1272 state in new org-mode buffers.  The setting can then be toggled on a
1273 per-buffer basis from the Org->Hyperlinks menu."
1274   :group 'org-link
1275   :type 'boolean)
1276
1277 (defcustom org-link-file-path-type 'adaptive
1278   "How the path name in file links should be stored.
1279 Valid values are:
1280
1281 relative  Relative to the current directory, i.e. the directory of the file
1282           into which the link is being inserted.
1283 absolute  Absolute path, if possible with ~ for home directory.
1284 noabbrev  Absolute path, no abbreviation of home directory.
1285 adaptive  Use relative path for files in the current directory and sub-
1286           directories of it.  For other files, use an absolute path."
1287   :group 'org-link
1288   :type '(choice
1289           (const relative)
1290           (const absolute)
1291           (const noabbrev)
1292           (const adaptive)))
1293
1294 (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
1295   "Types of links that should be activated in Org-mode files.
1296 This is a list of symbols, each leading to the activation of a certain link
1297 type.  In principle, it does not hurt to turn on most link types - there may
1298 be a small gain when turning off unused link types.  The types are:
1299
1300 bracket   The recommended [[link][description]] or [[link]] links with hiding.
1301 angle     Links in angular brackets that may contain whitespace like
1302           <bbdb:Carsten Dominik>.
1303 plain     Plain links in normal text, no whitespace, like http://google.com.
1304 radio     Text that is matched by a radio target, see manual for details.
1305 tag       Tag settings in a headline (link to tag search).
1306 date      Time stamps (link to calendar).
1307 footnote  Footnote labels.
1308
1309 Changing this variable requires a restart of Emacs to become effective."
1310   :group 'org-link
1311   :type '(set :greedy t
1312               (const :tag "Double bracket links" bracket)
1313               (const :tag "Angular bracket links" angle)
1314               (const :tag "Plain text links" plain)
1315               (const :tag "Radio target matches" radio)
1316               (const :tag "Tags" tag)
1317               (const :tag "Timestamps" date)
1318               (const :tag "Footnotes" footnote)))
1319
1320 (defcustom org-make-link-description-function nil
1321   "Function to use to generate link descriptions from links.
1322 If nil the link location will be used.  This function must take
1323 two parameters; the first is the link and the second the
1324 description `org-insert-link' has generated, and should return the
1325 description to use."
1326   :group 'org-link
1327   :type 'function)
1328
1329 (defgroup org-link-store nil
1330   "Options concerning storing links in Org-mode."
1331   :tag "Org Store Link"
1332   :group 'org-link)
1333
1334 (defcustom org-email-link-description-format "Email %c: %.30s"
1335   "Format of the description part of a link to an email or usenet message.
1336 The following %-escapes will be replaced by corresponding information:
1337
1338 %F   full \"From\" field
1339 %f   name, taken from \"From\" field, address if no name
1340 %T   full \"To\" field
1341 %t   first name in \"To\" field, address if no name
1342 %c   correspondent.  Usually \"from NAME\", but if you sent it yourself, it
1343      will be \"to NAME\".  See also the variable `org-from-is-user-regexp'.
1344 %s   subject
1345 %d   date
1346 %m   message-id.
1347
1348 You may use normal field width specification between the % and the letter.
1349 This is for example useful to limit the length of the subject.
1350
1351 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1352   :group 'org-link-store
1353   :type 'string)
1354
1355 (defcustom org-from-is-user-regexp
1356   (let (r1 r2)
1357     (when (and user-mail-address (not (string= user-mail-address "")))
1358       (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1359     (when (and user-full-name (not (string= user-full-name "")))
1360       (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1361     (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1362   "Regexp matched against the \"From:\" header of an email or usenet message.
1363 It should match if the message is from the user him/herself."
1364   :group 'org-link-store
1365   :type 'regexp)
1366
1367 (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
1368   "Non-nil means storing a link to an Org file will use entry IDs.
1369
1370 Note that before this variable is even considered, org-id must be loaded,
1371 so please customize `org-modules' and turn it on.
1372
1373 The variable can have the following values:
1374
1375 t     Create an ID if needed to make a link to the current entry.
1376
1377 create-if-interactive
1378       If `org-store-link' is called directly (interactively, as a user
1379       command), do create an ID to support the link.  But when doing the
1380       job for remember, only use the ID if it already exists.  The
1381       purpose of this setting is to avoid proliferation of unwanted
1382       IDs, just because you happen to be in an Org file when you
1383       call `org-remember' that automatically and preemptively
1384       creates a link.  If you do want to get an ID link in a remember
1385       template to an entry not having an ID, create it first by
1386       explicitly creating a link to it, using `C-c C-l' first.
1387
1388 create-if-interactive-and-no-custom-id
1389       Like create-if-interactive, but do not create an ID if there is
1390       a CUSTOM_ID property defined in the entry.  This is the default.
1391
1392 use-existing
1393       Use existing ID, do not create one.
1394
1395 nil   Never use an ID to make a link, instead link using a text search for
1396       the headline text."
1397   :group 'org-link-store
1398   :type '(choice
1399           (const :tag "Create ID to make link" t)
1400           (const :tag "Create if storing link interactively"
1401                  create-if-interactive)
1402           (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
1403                  create-if-interactive-and-no-custom-id)
1404           (const :tag "Only use existing" use-existing)
1405           (const :tag "Do not use ID to create link" nil)))
1406
1407 (defcustom org-context-in-file-links t
1408   "Non-nil means file links from `org-store-link' contain context.
1409 A search string will be added to the file name with :: as separator and
1410 used to find the context when the link is activated by the command
1411 `org-open-at-point'. When this option is t, the entire active region
1412 will be placed in the search string of the file link. If set to a
1413 positive integer, only the first n lines of context will be stored.
1414
1415 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1416 negates this setting for the duration of the command."
1417   :group 'org-link-store
1418   :type '(choice boolean integer))
1419
1420 (defcustom org-keep-stored-link-after-insertion nil
1421   "Non-nil means keep link in list for entire session.
1422
1423 The command `org-store-link' adds a link pointing to the current
1424 location to an internal list.  These links accumulate during a session.
1425 The command `org-insert-link' can be used to insert links into any
1426 Org-mode file (offering completion for all stored links).  When this
1427 option is nil, every link which has been inserted once using \\[org-insert-link]
1428 will be removed from the list, to make completing the unused links
1429 more efficient."
1430   :group 'org-link-store
1431   :type 'boolean)
1432
1433 (defgroup org-link-follow nil
1434   "Options concerning following links in Org-mode."
1435   :tag "Org Follow Link"
1436   :group 'org-link)
1437
1438 (defcustom org-link-translation-function nil
1439   "Function to translate links with different syntax to Org syntax.
1440 This can be used to translate links created for example by the Planner
1441 or emacs-wiki packages to Org syntax.
1442 The function must accept two parameters, a TYPE containing the link
1443 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1444 which is everything after the link protocol.  It should return a cons
1445 with possibly modified values of type and path.
1446 Org contains a function for this, so if you set this variable to
1447 `org-translate-link-from-planner', you should be able follow many
1448 links created by planner."
1449   :group 'org-link-follow
1450   :type 'function)
1451
1452 (defcustom org-follow-link-hook nil
1453   "Hook that is run after a link has been followed."
1454   :group 'org-link-follow
1455   :type 'hook)
1456
1457 (defcustom org-tab-follows-link nil
1458   "Non-nil means on links TAB will follow the link.
1459 Needs to be set before org.el is loaded.
1460 This really should not be used, it does not make sense, and the
1461 implementation is bad."
1462   :group 'org-link-follow
1463   :type 'boolean)
1464
1465 (defcustom org-return-follows-link nil
1466   "Non-nil means on links RET will follow the link."
1467   :group 'org-link-follow
1468   :type 'boolean)
1469
1470 (defcustom org-mouse-1-follows-link
1471   (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1472   "Non-nil means mouse-1 on a link will follow the link.
1473 A longer mouse click will still set point.  Does not work on XEmacs.
1474 Needs to be set before org.el is loaded."
1475   :group 'org-link-follow
1476   :type 'boolean)
1477
1478 (defcustom org-mark-ring-length 4
1479   "Number of different positions to be recorded in the ring.
1480 Changing this requires a restart of Emacs to work correctly."
1481   :group 'org-link-follow
1482   :type 'integer)
1483
1484 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1485   "Non-nil means internal links in Org files must exactly match a headline.
1486 When nil, the link search tries to match a phrase with all words
1487 in the search text."
1488   :group 'org-link-follow
1489   :type '(choice
1490           (const :tag "Use fuzy text search" nil)
1491           (const :tag "Match only exact headline" t)
1492           (const :tag "Match extact headline or query to create it"
1493                  query-to-create)))
1494
1495 (defcustom org-link-frame-setup
1496   '((vm . vm-visit-folder-other-frame)
1497     (gnus . org-gnus-no-new-news)
1498     (file . find-file-other-window)
1499     (wl . wl-other-frame))
1500   "Setup the frame configuration for following links.
1501 When following a link with Emacs, it may often be useful to display
1502 this link in another window or frame.  This variable can be used to
1503 set this up for the different types of links.
1504 For VM, use any of
1505     `vm-visit-folder'
1506     `vm-visit-folder-other-window'
1507     `vm-visit-folder-other-frame'
1508 For Gnus, use any of
1509     `gnus'
1510     `gnus-other-frame'
1511     `org-gnus-no-new-news'
1512 For FILE, use any of
1513     `find-file'
1514     `find-file-other-window'
1515     `find-file-other-frame'
1516 For Wanderlust use any of
1517     `wl'
1518     `wl-other-frame'
1519 For the calendar, use the variable `calendar-setup'.
1520 For BBDB, it is currently only possible to display the matches in
1521 another window."
1522   :group 'org-link-follow
1523   :type '(list
1524           (cons (const vm)
1525                 (choice
1526                  (const vm-visit-folder)
1527                  (const vm-visit-folder-other-window)
1528                  (const vm-visit-folder-other-frame)))
1529           (cons (const gnus)
1530                 (choice
1531                  (const gnus)
1532                  (const gnus-other-frame)
1533                  (const org-gnus-no-new-news)))
1534           (cons (const file)
1535                 (choice
1536                  (const find-file)
1537                  (const find-file-other-window)
1538                  (const find-file-other-frame)))
1539           (cons (const wl)
1540                 (choice
1541                  (const wl)
1542                  (const wl-other-frame)))))
1543
1544 (defcustom org-display-internal-link-with-indirect-buffer nil
1545   "Non-nil means use indirect buffer to display infile links.
1546 Activating internal links (from one location in a file to another location
1547 in the same file) normally just jumps to the location.  When the link is
1548 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1549 is displayed in
1550 another window.  When this option is set, the other window actually displays
1551 an indirect buffer clone of the current buffer, to avoid any visibility
1552 changes to the current buffer."
1553   :group 'org-link-follow
1554   :type 'boolean)
1555
1556 (defcustom org-open-non-existing-files nil
1557   "Non-nil means `org-open-file' will open non-existing files.
1558 When nil, an error will be generated.
1559 This variable applies only to external applications because they
1560 might choke on non-existing files.  If the link is to a file that
1561 will be opened in Emacs, the variable is ignored."
1562   :group 'org-link-follow
1563   :type 'boolean)
1564
1565 (defcustom org-open-directory-means-index-dot-org nil
1566   "Non-nil means a link to a directory really means to index.org.
1567 When nil, following a directory link will run dired or open a finder/explorer
1568 window on that directory."
1569   :group 'org-link-follow
1570   :type 'boolean)
1571
1572 (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
1573   "Function and arguments to call for following mailto links.
1574 This is a list with the first element being a Lisp function, and the
1575 remaining elements being arguments to the function.  In string arguments,
1576 %a will be replaced by the address, and %s will be replaced by the subject
1577 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1578   :group 'org-link-follow
1579   :type '(choice
1580           (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
1581           (const :tag "compose-mail" (compose-mail "%a" "%s"))
1582           (const :tag "message-mail" (message-mail "%a" "%s"))
1583           (cons :tag "other" (function) (repeat :tag "argument" sexp))))
1584
1585 (defcustom org-confirm-shell-link-function 'yes-or-no-p
1586   "Non-nil means ask for confirmation before executing shell links.
1587 Shell links can be dangerous: just think about a link
1588
1589      [[shell:rm -rf ~/*][Google Search]]
1590
1591 This link would show up in your Org-mode document as \"Google Search\",
1592 but really it would remove your entire home directory.
1593 Therefore we advise against setting this variable to nil.
1594 Just change it to `y-or-n-p' if you want to confirm with a
1595 single keystroke rather than having to type \"yes\"."
1596   :group 'org-link-follow
1597   :type '(choice
1598           (const :tag "with yes-or-no (safer)" yes-or-no-p)
1599           (const :tag "with y-or-n (faster)" y-or-n-p)
1600           (const :tag "no confirmation (dangerous)" nil)))
1601 (put 'org-confirm-shell-link-function
1602      'safe-local-variable
1603      #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1604
1605 (defcustom org-confirm-shell-link-not-regexp ""
1606   "A regexp to skip confirmation for shell links."
1607   :group 'org-link-follow
1608   :type 'regexp)
1609
1610 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
1611   "Non-nil means ask for confirmation before executing Emacs Lisp links.
1612 Elisp links can be dangerous: just think about a link
1613
1614      [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
1615
1616 This link would show up in your Org-mode document as \"Google Search\",
1617 but really it would remove your entire home directory.
1618 Therefore we advise against setting this variable to nil.
1619 Just change it to `y-or-n-p' if you want to confirm with a
1620 single keystroke rather than having to type \"yes\"."
1621   :group 'org-link-follow
1622   :type '(choice
1623           (const :tag "with yes-or-no (safer)" yes-or-no-p)
1624           (const :tag "with y-or-n (faster)" y-or-n-p)
1625           (const :tag "no confirmation (dangerous)" nil)))
1626 (put 'org-confirm-shell-link-function
1627      'safe-local-variable
1628      #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1629
1630 (defcustom org-confirm-elisp-link-not-regexp ""
1631   "A regexp to skip confirmation for Elisp links."
1632   :group 'org-link-follow
1633   :type 'regexp)
1634
1635 (defconst org-file-apps-defaults-gnu
1636   '((remote . emacs)
1637     (system . mailcap)
1638     (t . mailcap))
1639   "Default file applications on a UNIX or GNU/Linux system.
1640 See `org-file-apps'.")
1641
1642 (defconst org-file-apps-defaults-macosx
1643   '((remote . emacs)
1644     (t . "open %s")
1645     (system . "open %s")
1646     ("ps.gz"  . "gv %s")
1647     ("eps.gz" . "gv %s")
1648     ("dvi"    . "xdvi %s")
1649     ("fig"    . "xfig %s"))
1650   "Default file applications on a MacOS X system.
1651 The system \"open\" is known as a default, but we use X11 applications
1652 for some files for which the OS does not have a good default.
1653 See `org-file-apps'.")
1654
1655 (defconst org-file-apps-defaults-windowsnt
1656   (list
1657    '(remote . emacs)
1658    (cons t
1659          (list (if (featurep 'xemacs)
1660                    'mswindows-shell-execute
1661                  'w32-shell-execute)
1662                "open" 'file))
1663    (cons 'system
1664          (list (if (featurep 'xemacs)
1665                    'mswindows-shell-execute
1666                  'w32-shell-execute)
1667                "open" 'file)))
1668   "Default file applications on a Windows NT system.
1669 The system \"open\" is used for most files.
1670 See `org-file-apps'.")
1671
1672 (defcustom org-file-apps
1673   '(
1674     (auto-mode . emacs)
1675     ("\\.mm\\'" . default)
1676     ("\\.x?html?\\'" . default)
1677     ("\\.pdf\\'" . default)
1678     )
1679   "External applications for opening `file:path' items in a document.
1680 Org-mode uses system defaults for different file types, but
1681 you can use this variable to set the application for a given file
1682 extension.  The entries in this list are cons cells where the car identifies
1683 files and the cdr the corresponding command.  Possible values for the
1684 file identifier are
1685  \"string\"    A string as a file identifier can be interpreted in different
1686                ways, depending on its contents:
1687
1688                - Alphanumeric characters only:
1689                  Match links with this file extension.
1690                  Example: (\"pdf\" . \"evince %s\")
1691                           to open PDFs with evince.
1692
1693                - Regular expression: Match links where the
1694                  filename matches the regexp.  If you want to
1695                  use groups here, use shy groups.
1696
1697                  Example: (\"\\.x?html\\'\" . \"firefox %s\")
1698                           (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
1699                           to open *.html and *.xhtml with firefox.
1700
1701                - Regular expression which contains (non-shy) groups:
1702                  Match links where the whole link, including \"::\", and
1703                  anything after that, matches the regexp.
1704                  In a custom command string, %1, %2, etc. are replaced with
1705                  the parts of the link that were matched by the groups.
1706                  For backwards compatibility, if a command string is given
1707                  that does not use any of the group matches, this case is
1708                  handled identically to the second one (i.e. match against
1709                  file name only).
1710                  In a custom lisp form, you can access the group matches with
1711                  (match-string n link).
1712
1713                  Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
1714                      to open [[file:document.pdf::5]] with evince at page 5.
1715
1716  `directory'   Matches a directory
1717  `remote'      Matches a remote file, accessible through tramp or efs.
1718                Remote files most likely should be visited through Emacs
1719                because external applications cannot handle such paths.
1720 `auto-mode'    Matches files that are matched by any entry in `auto-mode-alist',
1721                so all files Emacs knows how to handle.  Using this with
1722                command `emacs' will open most files in Emacs.  Beware that this
1723                will also open html files inside Emacs, unless you add
1724                (\"html\" . default) to the list as well.
1725  t             Default for files not matched by any of the other options.
1726  `system'      The system command to open files, like `open' on Windows
1727                and Mac OS X, and mailcap under GNU/Linux.  This is the command
1728                that will be selected if you call `C-c C-o' with a double
1729                \\[universal-argument] \\[universal-argument] prefix.
1730
1731 Possible values for the command are:
1732  `emacs'       The file will be visited by the current Emacs process.
1733  `default'     Use the default application for this file type, which is the
1734                association for t in the list, most likely in the system-specific
1735                part.
1736                This can be used to overrule an unwanted setting in the
1737                system-specific variable.
1738  `system'      Use the system command for opening files, like \"open\".
1739                This command is specified by the entry whose car is `system'.
1740                Most likely, the system-specific version of this variable
1741                does define this command, but you can overrule/replace it
1742                here.
1743  string        A command to be executed by a shell; %s will be replaced
1744                by the path to the file.
1745  sexp          A Lisp form which will be evaluated.  The file path will
1746                be available in the Lisp variable `file'.
1747 For more examples, see the system specific constants
1748 `org-file-apps-defaults-macosx'
1749 `org-file-apps-defaults-windowsnt'
1750 `org-file-apps-defaults-gnu'."
1751   :group 'org-link-follow
1752   :type '(repeat
1753           (cons (choice :value ""
1754                         (string :tag "Extension")
1755                         (const :tag "System command to open files" system)
1756                         (const :tag "Default for unrecognized files" t)
1757                         (const :tag "Remote file" remote)
1758                         (const :tag "Links to a directory" directory)
1759                         (const :tag "Any files that have Emacs modes"
1760                                auto-mode))
1761                 (choice :value ""
1762                         (const :tag "Visit with Emacs" emacs)
1763                         (const :tag "Use default" default)
1764                         (const :tag "Use the system command" system)
1765                         (string :tag "Command")
1766                         (sexp :tag "Lisp form")))))
1767
1768
1769
1770 (defgroup org-refile nil
1771   "Options concerning refiling entries in Org-mode."
1772   :tag "Org Refile"
1773   :group 'org)
1774
1775 (defcustom org-directory "~/org"
1776   "Directory with org files.
1777 This is just a default location to look for Org files.  There is no need
1778 at all to put your files into this directory.  It is only used in the
1779 following situations:
1780
1781 1. When a remember template specifies a target file that is not an
1782    absolute path.  The path will then be interpreted relative to
1783    `org-directory'
1784 2. When a remember note is filed away in an interactive way (when exiting the
1785    note buffer with `C-1 C-c C-c'.  The user is prompted for an org file,
1786    with `org-directory' as the default path."
1787   :group 'org-refile
1788   :group 'org-remember
1789   :type 'directory)
1790
1791 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
1792   "Default target for storing notes.
1793 Used as a fall back file for org-remember.el and org-capture.el, for
1794 templates that do not specify a target file."
1795   :group 'org-refile
1796   :group 'org-remember
1797   :type '(choice
1798           (const :tag "Default from remember-data-file" nil)
1799           file))
1800
1801 (defcustom org-goto-interface 'outline
1802   "The default interface to be used for `org-goto'.
1803 Allowed values are:
1804 outline                  The interface shows an outline of the relevant file
1805                          and the correct heading is found by moving through
1806                          the outline or by searching with incremental search.
1807 outline-path-completion  Headlines in the current buffer are offered via
1808                          completion.  This is the interface also used by
1809                          the refile command."
1810   :group 'org-refile
1811   :type '(choice
1812           (const :tag "Outline" outline)
1813           (const :tag "Outline-path-completion" outline-path-completion)))
1814
1815 (defcustom org-goto-max-level 5
1816   "Maximum target level when running `org-goto' with refile interface."
1817   :group 'org-refile
1818   :type 'integer)
1819
1820 (defcustom org-reverse-note-order nil
1821   "Non-nil means store new notes at the beginning of a file or entry.
1822 When nil, new notes will be filed to the end of a file or entry.
1823 This can also be a list with cons cells of regular expressions that
1824 are matched against file names, and values."
1825   :group 'org-remember
1826   :group 'org-refile
1827   :type '(choice
1828           (const :tag "Reverse always" t)
1829           (const :tag "Reverse never" nil)
1830           (repeat :tag "By file name regexp"
1831                   (cons regexp boolean))))
1832
1833 (defcustom org-log-refile nil
1834   "Information to record when a task is refiled.
1835
1836 Possible values are:
1837
1838 nil     Don't add anything
1839 time    Add a time stamp to the task
1840 note    Prompt for a note and add it with template `org-log-note-headings'
1841
1842 This option can also be set with on a per-file-basis with
1843
1844    #+STARTUP: nologrefile
1845    #+STARTUP: logrefile
1846    #+STARTUP: lognoterefile
1847
1848 You can have local logging settings for a subtree by setting the LOGGING
1849 property to one or more of these keywords.
1850
1851 When bulk-refiling from the agenda, the value `note' is forbidden and
1852 will temporarily be changed to `time'."
1853   :group 'org-refile
1854   :group 'org-progress
1855   :type '(choice
1856           (const :tag "No logging" nil)
1857           (const :tag "Record timestamp" time)
1858           (const :tag "Record timestamp with note." note)))
1859
1860 (defcustom org-refile-targets nil
1861   "Targets for refiling entries with \\[org-refile].
1862 This is list of cons cells.  Each cell contains:
1863 - a specification of the files to be considered, either a list of files,
1864   or a symbol whose function or variable value will be used to retrieve
1865   a file name or a list of file names.  If you use `org-agenda-files' for
1866   that, all agenda files will be scanned for targets.  Nil means consider
1867   headings in the current buffer.
1868 - A specification of how to find candidate refile targets.  This may be
1869   any of:
1870   - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
1871     This tag has to be present in all target headlines, inheritance will
1872     not be considered.
1873   - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
1874     todo keyword.
1875   - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
1876     headlines that are refiling targets.
1877   - a cons cell (:level . N).  Any headline of level N is considered a target.
1878     Note that, when `org-odd-levels-only' is set, level corresponds to
1879     order in hierarchy, not to the number of stars.
1880   - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1881     Note that, when `org-odd-levels-only' is set, level corresponds to
1882     order in hierarchy, not to the number of stars.
1883
1884 You can set the variable `org-refile-target-verify-function' to a function
1885 to verify each headline found by the simple criteria above.
1886
1887 When this variable is nil, all top-level headlines in the current buffer
1888 are used, equivalent to the value `((nil . (:level . 1))'."
1889   :group 'org-refile
1890   :type '(repeat
1891           (cons
1892            (choice :value org-agenda-files
1893                    (const :tag "All agenda files" org-agenda-files)
1894                    (const :tag "Current buffer" nil)
1895                    (function) (variable) (file))
1896            (choice :tag "Identify target headline by"
1897             (cons :tag "Specific tag" (const :value :tag) (string))
1898             (cons :tag "TODO keyword" (const :value :todo) (string))
1899             (cons :tag "Regular expression" (const :value :regexp) (regexp))
1900             (cons :tag "Level number" (const :value :level) (integer))
1901             (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
1902
1903 (defcustom org-refile-target-verify-function nil
1904   "Function to verify if the headline at point should be a refile target.
1905 The function will be called without arguments, with point at the
1906 beginning of the headline.  It should return t and leave point
1907 where it is if the headline is a valid target for refiling.
1908
1909 If the target should not be selected, the function must return nil.
1910 In addition to this, it may move point to a place from where the search
1911 should be continued.  For example, the function may decide that the entire
1912 subtree of the current entry should be excluded and move point to the end
1913 of the subtree."
1914   :group 'org-refile
1915   :type 'function)
1916
1917 (defcustom org-refile-use-cache nil
1918   "Non-nil means cache refile targets to speed up the process.
1919 The cache for a particular file will be updated automatically when
1920 the buffer has been killed, or when any of the marker used for flagging
1921 refile targets no longer points at a live buffer.
1922 If you have added new entries to a buffer that might themselves be targets,
1923 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1924 find that easier, `C-u C-u C-u C-c C-w'."
1925   :group 'org-refile
1926   :type 'boolean)
1927
1928 (defcustom org-refile-use-outline-path nil
1929   "Non-nil means provide refile targets as paths.
1930 So a level 3 headline will be available as level1/level2/level3.
1931
1932 When the value is `file', also include the file name (without directory)
1933 into the path.  In this case, you can also stop the completion after
1934 the file name, to get entries inserted as top level in the file.
1935
1936 When `full-file-path', include the full file path."
1937   :group 'org-refile
1938   :type '(choice
1939           (const :tag "Not" nil)
1940           (const :tag "Yes" t)
1941           (const :tag "Start with file name" file)
1942           (const :tag "Start with full file path" full-file-path)))
1943
1944 (defcustom org-outline-path-complete-in-steps t
1945   "Non-nil means complete the outline path in hierarchical steps.
1946 When Org-mode uses the refile interface to select an outline path
1947 \(see variable `org-refile-use-outline-path'), the completion of
1948 the path can be done is a single go, or if can be done in steps down
1949 the headline hierarchy.  Going in steps is probably the best if you
1950 do not use a special completion package like `ido' or `icicles'.
1951 However, when using these packages, going in one step can be very
1952 fast, while still showing the whole path to the entry."
1953   :group 'org-refile
1954   :type 'boolean)
1955
1956 (defcustom org-refile-allow-creating-parent-nodes nil
1957   "Non-nil means allow to create new nodes as refile targets.
1958 New nodes are then created by adding \"/new node name\" to the completion
1959 of an existing node.  When the value of this variable is `confirm',
1960 new node creation must be confirmed by the user (recommended)
1961 When nil, the completion must match an existing entry.
1962
1963 Note that, if the new heading is not seen by the criteria
1964 listed in `org-refile-targets', multiple instances of the same
1965 heading would be created by trying again to file under the new
1966 heading."
1967   :group 'org-refile
1968   :type '(choice
1969           (const :tag "Never" nil)
1970           (const :tag "Always" t)
1971           (const :tag "Prompt for confirmation" confirm)))
1972
1973 (defgroup org-todo nil
1974   "Options concerning TODO items in Org-mode."
1975   :tag "Org TODO"
1976   :group 'org)
1977
1978 (defgroup org-progress nil
1979   "Options concerning Progress logging in Org-mode."
1980   :tag "Org Progress"
1981   :group 'org-time)
1982
1983 (defvar org-todo-interpretation-widgets
1984   '((:tag "Sequence (cycling hits every state)" sequence)
1985     (:tag "Type     (cycling directly to DONE)" type))
1986   "The available interpretation symbols for customizing `org-todo-keywords'.
1987 Interested libraries should add to this list.")
1988
1989 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
1990   "List of TODO entry keyword sequences and their interpretation.
1991 \\<org-mode-map>This is a list of sequences.
1992
1993 Each sequence starts with a symbol, either `sequence' or `type',
1994 indicating if the keywords should be interpreted as a sequence of
1995 action steps, or as different types of TODO items.  The first
1996 keywords are states requiring action - these states will select a headline
1997 for inclusion into the global TODO list Org-mode produces.  If one of
1998 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
1999 signify that no further action is necessary.  If \"|\" is not found,
2000 the last keyword is treated as the only DONE state of the sequence.
2001
2002 The command \\[org-todo] cycles an entry through these states, and one
2003 additional state where no keyword is present.  For details about this
2004 cycling, see the manual.
2005
2006 TODO keywords and interpretation can also be set on a per-file basis with
2007 the special #+SEQ_TODO and #+TYP_TODO lines.
2008
2009 Each keyword can optionally specify a character for fast state selection
2010 \(in combination with the variable `org-use-fast-todo-selection')
2011 and specifiers for state change logging, using the same syntax
2012 that is used in the \"#+TODO:\" lines.  For example, \"WAIT(w)\" says
2013 that the WAIT state can be selected with the \"w\" key.  \"WAIT(w!)\"
2014 indicates to record a time stamp each time this state is selected.
2015
2016 Each keyword may also specify if a timestamp or a note should be
2017 recorded when entering or leaving the state, by adding additional
2018 characters in the parenthesis after the keyword.  This looks like this:
2019 \"WAIT(w@/!)\".  \"@\" means to add a note (with time), \"!\" means to
2020 record only the time of the state change.  With X and Y being either
2021 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2022 Y when leaving the state if and only if the *target* state does not
2023 define X.  You may omit any of the fast-selection key or X or /Y,
2024 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2025
2026 For backward compatibility, this variable may also be just a list
2027 of keywords - in this case the interpretation (sequence or type) will be
2028 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2029   :group 'org-todo
2030   :group 'org-keywords
2031   :type '(choice
2032           (repeat :tag "Old syntax, just keywords"
2033                   (string :tag "Keyword"))
2034           (repeat :tag "New syntax"
2035                   (cons
2036                    (choice
2037                     :tag "Interpretation"
2038                     ;;Quick and dirty way to see
2039                     ;;`org-todo-interpretations'.  This takes the
2040                     ;;place of item arguments
2041                     :convert-widget
2042                     (lambda (widget)
2043                       (widget-put widget
2044                                   :args (mapcar
2045                                          #'(lambda (x)
2046                                              (widget-convert
2047                                               (cons 'const x)))
2048                                          org-todo-interpretation-widgets))
2049                       widget))
2050                    (repeat
2051                     (string :tag "Keyword"))))))
2052
2053 (defvar org-todo-keywords-1 nil
2054   "All TODO and DONE keywords active in a buffer.")
2055 (make-variable-buffer-local 'org-todo-keywords-1)
2056 (defvar org-todo-keywords-for-agenda nil)
2057 (defvar org-done-keywords-for-agenda nil)
2058 (defvar org-drawers-for-agenda nil)
2059 (defvar org-todo-keyword-alist-for-agenda nil)
2060 (defvar org-tag-alist-for-agenda nil)
2061 (defvar org-agenda-contributing-files nil)
2062 (defvar org-not-done-keywords nil)
2063 (make-variable-buffer-local 'org-not-done-keywords)
2064 (defvar org-done-keywords nil)
2065 (make-variable-buffer-local 'org-done-keywords)
2066 (defvar org-todo-heads nil)
2067 (make-variable-buffer-local 'org-todo-heads)
2068 (defvar org-todo-sets nil)
2069 (make-variable-buffer-local 'org-todo-sets)
2070 (defvar org-todo-log-states nil)
2071 (make-variable-buffer-local 'org-todo-log-states)
2072 (defvar org-todo-kwd-alist nil)
2073 (make-variable-buffer-local 'org-todo-kwd-alist)
2074 (defvar org-todo-key-alist nil)
2075 (make-variable-buffer-local 'org-todo-key-alist)
2076 (defvar org-todo-key-trigger nil)
2077 (make-variable-buffer-local 'org-todo-key-trigger)
2078
2079 (defcustom org-todo-interpretation 'sequence
2080   "Controls how TODO keywords are interpreted.
2081 This variable is in principle obsolete and is only used for
2082 backward compatibility, if the interpretation of todo keywords is
2083 not given already in `org-todo-keywords'.  See that variable for
2084 more information."
2085   :group 'org-todo
2086   :group 'org-keywords
2087   :type '(choice (const sequence)
2088                  (const type)))
2089
2090 (defcustom org-use-fast-todo-selection t
2091   "Non-nil means use the fast todo selection scheme with C-c C-t.
2092 This variable describes if and under what circumstances the cycling
2093 mechanism for TODO keywords will be replaced by a single-key, direct
2094 selection scheme.
2095
2096 When nil, fast selection is never used.
2097
2098 When the symbol `prefix', it will be used when `org-todo' is called with
2099 a prefix argument,  i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2100 in an agenda buffer.
2101
2102 When t, fast selection is used by default.  In this case, the prefix
2103 argument forces cycling instead.
2104
2105 In all cases, the special interface is only used if access keys have actually
2106 been assigned by the user, i.e. if keywords in the configuration are followed
2107 by a letter in parenthesis, like TODO(t)."
2108   :group 'org-todo
2109   :type '(choice
2110           (const :tag "Never" nil)
2111           (const :tag "By default" t)
2112           (const :tag "Only with C-u C-c C-t" prefix)))
2113
2114 (defcustom org-provide-todo-statistics t
2115   "Non-nil means update todo statistics after insert and toggle.
2116 ALL-HEADLINES means update todo statistics by including headlines
2117 with no TODO keyword as well, counting them as not done.
2118 A list of TODO keywords means the same, but skip keywords that are
2119 not in this list.
2120
2121 When this is set, todo statistics is updated in the parent of the
2122 current entry each time a todo state is changed."
2123   :group 'org-todo
2124   :type '(choice
2125           (const :tag "Yes, only for TODO entries" t)
2126           (const :tag "Yes, including all entries" 'all-headlines)
2127           (repeat :tag "Yes, for TODOs in this list"
2128                   (string :tag "TODO keyword"))
2129           (other :tag "No TODO statistics" nil)))
2130
2131 (defcustom org-hierarchical-todo-statistics t
2132   "Non-nil means TODO statistics covers just direct children.
2133 When nil, all entries in the subtree are considered.
2134 This has only an effect if `org-provide-todo-statistics' is set.
2135 To set this to nil for only a single subtree, use a COOKIE_DATA
2136 property and include the word \"recursive\" into the value."
2137   :group 'org-todo
2138   :type 'boolean)
2139
2140 (defcustom org-after-todo-state-change-hook nil
2141   "Hook which is run after the state of a TODO item was changed.
2142 The new state (a string with a TODO keyword, or nil) is available in the
2143 Lisp variable `state'."
2144   :group 'org-todo
2145   :type 'hook)
2146
2147 (defvar org-blocker-hook nil
2148   "Hook for functions that are allowed to block a state change.
2149
2150 Each function gets as its single argument a property list, see
2151 `org-trigger-hook' for more information about this list.
2152
2153 If any of the functions in this hook returns nil, the state change
2154 is blocked.")
2155
2156 (defvar org-trigger-hook nil
2157   "Hook for functions that are triggered by a state change.
2158
2159 Each function gets as its single argument a property list with at least
2160 the following elements:
2161
2162  (:type type-of-change :position pos-at-entry-start
2163   :from old-state :to new-state)
2164
2165 Depending on the type, more properties may be present.
2166
2167 This mechanism is currently implemented for:
2168
2169 TODO state changes
2170 ------------------
2171 :type  todo-state-change
2172 :from  previous state (keyword as a string), or nil, or a symbol
2173        'todo' or 'done', to indicate the general type of state.
2174 :to    new state, like in :from")
2175
2176 (defcustom org-enforce-todo-dependencies nil
2177   "Non-nil means undone TODO entries will block switching the parent to DONE.
2178 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2179 be blocked if any prior sibling is not yet done.
2180 Finally, if the parent is blocked because of ordered siblings of its own,
2181 the child will also be blocked.
2182 This variable needs to be set before org.el is loaded, and you need to
2183 restart Emacs after a change to make the change effective.  The only way
2184 to change is while Emacs is running is through the customize interface."
2185   :set (lambda (var val)
2186          (set var val)
2187          (if val
2188              (add-hook 'org-blocker-hook
2189                        'org-block-todo-from-children-or-siblings-or-parent)
2190            (remove-hook 'org-blocker-hook
2191                         'org-block-todo-from-children-or-siblings-or-parent)))
2192   :group 'org-todo
2193   :type 'boolean)
2194
2195 (defcustom org-enforce-todo-checkbox-dependencies nil
2196   "Non-nil means unchecked boxes will block switching the parent to DONE.
2197 When this is nil, checkboxes have no influence on switching TODO states.
2198 When non-nil, you first need to check off all check boxes before the TODO
2199 entry can be switched to DONE.
2200 This variable needs to be set before org.el is loaded, and you need to
2201 restart Emacs after a change to make the change effective.  The only way
2202 to change is while Emacs is running is through the customize interface."
2203   :set (lambda (var val)
2204          (set var val)
2205          (if val
2206              (add-hook 'org-blocker-hook
2207                        'org-block-todo-from-checkboxes)
2208            (remove-hook 'org-blocker-hook
2209                         'org-block-todo-from-checkboxes)))
2210   :group 'org-todo
2211   :type 'boolean)
2212
2213 (defcustom org-treat-insert-todo-heading-as-state-change nil
2214   "Non-nil means inserting a TODO heading is treated as state change.
2215 So when the command \\[org-insert-todo-heading] is used, state change
2216 logging will apply if appropriate.  When nil, the new TODO item will
2217 be inserted directly, and no logging will take place."
2218   :group 'org-todo
2219   :type 'boolean)
2220
2221 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2222   "Non-nil means switching TODO states with S-cursor counts as state change.
2223 This is the default behavior.  However, setting this to nil allows a
2224 convenient way to select a TODO state and bypass any logging associated
2225 with that."
2226   :group 'org-todo
2227   :type 'boolean)
2228
2229 (defcustom org-todo-state-tags-triggers nil
2230   "Tag changes that should be triggered by TODO state changes.
2231 This is a list.  Each entry is
2232
2233   (state-change (tag . flag) .......)
2234
2235 State-change can be a string with a state, and empty string to indicate the
2236 state that has no TODO keyword, or it can be one of the symbols `todo'
2237 or `done', meaning any not-done or done state, respectively."
2238   :group 'org-todo
2239   :group 'org-tags
2240   :type '(repeat
2241           (cons (choice :tag "When changing to"
2242                  (const :tag "Not-done state" todo)
2243                  (const :tag "Done state" done)
2244                  (string :tag "State"))
2245                 (repeat
2246                  (cons :tag "Tag action"
2247                        (string :tag "Tag")
2248                        (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2249
2250 (defcustom org-log-done nil
2251   "Information to record when a task moves to the DONE state.
2252
2253 Possible values are:
2254
2255 nil     Don't add anything, just change the keyword
2256 time    Add a time stamp to the task
2257 note    Prompt for a note and add it with template `org-log-note-headings'
2258
2259 This option can also be set with on a per-file-basis with
2260
2261    #+STARTUP: nologdone
2262    #+STARTUP: logdone
2263    #+STARTUP: lognotedone
2264
2265 You can have local logging settings for a subtree by setting the LOGGING
2266 property to one or more of these keywords."
2267   :group 'org-todo
2268   :group 'org-progress
2269   :type '(choice
2270           (const :tag "No logging" nil)
2271           (const :tag "Record CLOSED timestamp" time)
2272           (const :tag "Record CLOSED timestamp with note." note)))
2273
2274 ;; Normalize old uses of org-log-done.
2275 (cond
2276  ((eq org-log-done t) (setq org-log-done 'time))
2277  ((and (listp org-log-done) (memq 'done org-log-done))
2278   (setq org-log-done 'note)))
2279
2280 (defcustom org-log-reschedule nil
2281   "Information to record when the scheduling date of a tasks is modified.
2282
2283 Possible values are:
2284
2285 nil     Don't add anything, just change the date
2286 time    Add a time stamp to the task
2287 note    Prompt for a note and add it with template `org-log-note-headings'
2288
2289 This option can also be set with on a per-file-basis with
2290
2291    #+STARTUP: nologreschedule
2292    #+STARTUP: logreschedule
2293    #+STARTUP: lognotereschedule"
2294   :group 'org-todo
2295   :group 'org-progress
2296   :type '(choice
2297           (const :tag "No logging" nil)
2298           (const :tag "Record timestamp" time)
2299           (const :tag "Record timestamp with note." note)))
2300
2301 (defcustom org-log-redeadline nil
2302   "Information to record when the deadline date of a tasks is modified.
2303
2304 Possible values are:
2305
2306 nil     Don't add anything, just change the date
2307 time    Add a time stamp to the task
2308 note    Prompt for a note and add it with template `org-log-note-headings'
2309
2310 This option can also be set with on a per-file-basis with
2311
2312    #+STARTUP: nologredeadline
2313    #+STARTUP: logredeadline
2314    #+STARTUP: lognoteredeadline
2315
2316 You can have local logging settings for a subtree by setting the LOGGING
2317 property to one or more of these keywords."
2318   :group 'org-todo
2319   :group 'org-progress
2320   :type '(choice
2321           (const :tag "No logging" nil)
2322           (const :tag "Record timestamp" time)
2323           (const :tag "Record timestamp with note." note)))
2324
2325 (defcustom org-log-note-clock-out nil
2326   "Non-nil means record a note when clocking out of an item.
2327 This can also be configured on a per-file basis by adding one of
2328 the following lines anywhere in the buffer:
2329
2330    #+STARTUP: lognoteclock-out
2331    #+STARTUP: nolognoteclock-out"
2332   :group 'org-todo
2333   :group 'org-progress
2334   :type 'boolean)
2335
2336 (defcustom org-log-done-with-time t
2337   "Non-nil means the CLOSED time stamp will contain date and time.
2338 When nil, only the date will be recorded."
2339   :group 'org-progress
2340   :type 'boolean)
2341
2342 (defcustom org-log-note-headings
2343   '((done .  "CLOSING NOTE %t")
2344     (state . "State %-12s from %-12S %t")
2345     (note .  "Note taken on %t")
2346     (reschedule .  "Rescheduled from %S on %t")
2347     (delschedule .  "Not scheduled, was %S on %t")
2348     (redeadline .  "New deadline from %S on %t")
2349     (deldeadline .  "Removed deadline, was %S on %t")
2350     (refile . "Refiled on %t")
2351     (clock-out . ""))
2352   "Headings for notes added to entries.
2353 The value is an alist, with the car being a symbol indicating the note
2354 context, and the cdr is the heading to be used.  The heading may also be the
2355 empty string.
2356 %t in the heading will be replaced by a time stamp.
2357 %T will be an active time stamp instead the default inactive one
2358 %s will be replaced by the new TODO state, in double quotes.
2359 %S will be replaced by the old TODO state, in double quotes.
2360 %u will be replaced by the user name.
2361 %U will be replaced by the full user name.
2362
2363 In fact, it is not a good idea to change the `state' entry, because
2364 agenda log mode depends on the format of these entries."
2365   :group  'org-todo
2366   :group  'org-progress
2367   :type '(list :greedy t
2368           (cons (const :tag "Heading when closing an item" done) string)
2369           (cons (const :tag
2370                        "Heading when changing todo state (todo sequence only)"
2371                        state) string)
2372           (cons (const :tag "Heading when just taking a note" note) string)
2373           (cons (const :tag "Heading when clocking out" clock-out) string)
2374           (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2375           (cons (const :tag "Heading when rescheduling" reschedule) string)
2376           (cons (const :tag "Heading when changing deadline"  redeadline) string)
2377           (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2378           (cons (const :tag "Heading when refiling" refile) string)))
2379
2380 (unless (assq 'note org-log-note-headings)
2381   (push '(note . "%t") org-log-note-headings))
2382
2383 (defcustom org-log-into-drawer nil
2384   "Non-nil means insert state change notes and time stamps into a drawer.
2385 When nil, state changes notes will be inserted after the headline and
2386 any scheduling and clock lines, but not inside a drawer.
2387
2388 The value of this variable should be the name of the drawer to use.
2389 LOGBOOK is proposed as the default drawer for this purpose, you can
2390 also set this to a string to define the drawer of your choice.
2391
2392 A value of t is also allowed, representing \"LOGBOOK\".
2393
2394 If this variable is set, `org-log-state-notes-insert-after-drawers'
2395 will be ignored.
2396
2397 You can set the property LOG_INTO_DRAWER to overrule this setting for
2398 a subtree."
2399   :group 'org-todo
2400   :group 'org-progress
2401   :type '(choice
2402           (const :tag "Not into a drawer" nil)
2403           (const :tag "LOGBOOK" t)
2404           (string :tag "Other")))
2405
2406 (if (fboundp 'defvaralias)
2407     (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
2408
2409 (defun org-log-into-drawer ()
2410   "Return the value of `org-log-into-drawer', but let properties overrule.
2411 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2412 used instead of the default value."
2413   (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
2414     (cond
2415      ((or (not p) (equal p "nil")) org-log-into-drawer)
2416      ((equal p "t") "LOGBOOK")
2417      (t p))))
2418
2419 (defcustom org-log-state-notes-insert-after-drawers nil
2420   "Non-nil means insert state change notes after any drawers in entry.
2421 Only the drawers that *immediately* follow the headline and the
2422 deadline/scheduled line are skipped.
2423 When nil, insert notes right after the heading and perhaps the line
2424 with deadline/scheduling if present.
2425
2426 This variable will have no effect if `org-log-into-drawer' is
2427 set."
2428   :group 'org-todo
2429   :group 'org-progress
2430   :type 'boolean)
2431
2432 (defcustom org-log-states-order-reversed t
2433   "Non-nil means the latest state note will be directly after heading.
2434 When nil, the state change notes will be ordered according to time."
2435   :group 'org-todo
2436   :group 'org-progress
2437   :type 'boolean)
2438
2439 (defcustom org-todo-repeat-to-state nil
2440   "The TODO state to which a repeater should return the repeating task.
2441 By default this is the first task in a TODO sequence, or the previous state
2442 in a TODO_TYP set.  But you can specify another task here.
2443 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2444   :group 'org-todo
2445   :type '(choice (const :tag "Head of sequence" nil)
2446                  (string :tag "Specific state")))
2447
2448 (defcustom org-log-repeat 'time
2449   "Non-nil means record moving through the DONE state when triggering repeat.
2450 An auto-repeating task is immediately switched back to TODO when
2451 marked DONE.  If you are not logging state changes (by adding \"@\"
2452 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2453 record a closing note, there will be no record of the task moving
2454 through DONE. This variable forces taking a note anyway.
2455
2456 nil     Don't force a record
2457 time    Record a time stamp
2458 note    Record a note
2459
2460 This option can also be set with on a per-file-basis with
2461
2462    #+STARTUP: logrepeat
2463    #+STARTUP: lognoterepeat
2464    #+STARTUP: nologrepeat
2465
2466 You can have local logging settings for a subtree by setting the LOGGING
2467 property to one or more of these keywords."
2468   :group 'org-todo
2469   :group 'org-progress
2470   :type '(choice
2471           (const :tag "Don't force a record" nil)
2472           (const :tag "Force recording the DONE state" time)
2473           (const :tag "Force recording a note with the DONE state" note)))
2474
2475
2476 (defgroup org-priorities nil
2477   "Priorities in Org-mode."
2478   :tag "Org Priorities"
2479   :group 'org-todo)
2480
2481 (defcustom org-enable-priority-commands t
2482   "Non-nil means priority commands are active.
2483 When nil, these commands will be disabled, so that you never accidentally
2484 set a priority."
2485   :group 'org-priorities
2486   :type 'boolean)
2487
2488 (defcustom org-highest-priority ?A
2489   "The highest priority of TODO items.  A character like ?A, ?B etc.
2490 Must have a smaller ASCII number than `org-lowest-priority'."
2491   :group 'org-priorities
2492   :type 'character)
2493
2494 (defcustom org-lowest-priority ?C
2495   "The lowest priority of TODO items.  A character like ?A, ?B etc.
2496 Must have a larger ASCII number than `org-highest-priority'."
2497   :group 'org-priorities
2498   :type 'character)
2499
2500 (defcustom org-default-priority ?B
2501   "The default priority of TODO items.
2502 This is the priority an item gets if no explicit priority is given.
2503 When starting to cycle on an empty priority the first step in the cycle
2504 depends on `org-priority-start-cycle-with-default'.  The resulting first
2505 step priority must not exceed the range from `org-highest-priority' to
2506 `org-lowest-priority' which means that `org-default-priority' has to be
2507 in this range exclusive or inclusive the range boundaries.  Else the
2508 first step refuses to set the default and the second will fall back
2509 to (depending on the command used) the highest or lowest priority."
2510   :group 'org-priorities
2511   :type 'character)
2512
2513 (defcustom org-priority-start-cycle-with-default t
2514   "Non-nil means start with default priority when starting to cycle.
2515 When this is nil, the first step in the cycle will be (depending on the
2516 command used) one higher or lower than the default priority.
2517 See also `org-default-priority'."
2518   :group 'org-priorities
2519   :type 'boolean)
2520
2521 (defcustom org-get-priority-function nil
2522   "Function to extract the priority from a string.
2523 The string is normally the headline.  If this is nil Org computes the
2524 priority from the priority cookie like [#A] in the headline.  It returns
2525 an integer, increasing by 1000 for each priority level.
2526 The user can set a different function here, which should take a string
2527 as an argument and return the numeric priority."
2528   :group 'org-priorities
2529   :type 'function)
2530
2531 (defgroup org-time nil
2532   "Options concerning time stamps and deadlines in Org-mode."
2533   :tag "Org Time"
2534   :group 'org)
2535
2536 (defcustom org-insert-labeled-timestamps-at-point nil
2537   "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2538 When nil, these labeled time stamps are forces into the second line of an
2539 entry, just after the headline.  When scheduling from the global TODO list,
2540 the time stamp will always be forced into the second line."
2541   :group 'org-time
2542   :type 'boolean)
2543
2544 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
2545   "Formats for `format-time-string' which are used for time stamps.
2546 It is not recommended to change this constant.")
2547
2548 (defcustom org-time-stamp-rounding-minutes '(0 5)
2549   "Number of minutes to round time stamps to.
2550 These are two values, the first applies when first creating a time stamp.
2551 The second applies when changing it with the commands `S-up' and `S-down'.
2552 When changing the time stamp, this means that it will change in steps
2553 of N minutes, as given by the second value.
2554
2555 When a setting is 0 or 1, insert the time unmodified.  Useful rounding
2556 numbers should be factors of 60, so for example 5, 10, 15.
2557
2558 When this is larger than 1, you can still force an exact time stamp by using
2559 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2560 and by using a prefix arg to `S-up/down' to specify the exact number
2561 of minutes to shift."
2562   :group 'org-time
2563   :get #'(lambda (var) ; Make sure both elements are there
2564           (if (integerp (default-value var))
2565               (list (default-value var) 5)
2566             (default-value var)))
2567   :type '(list
2568           (integer :tag "when inserting times")
2569           (integer :tag "when modifying times")))
2570
2571 ;; Normalize old customizations of this variable.
2572 (when (integerp org-time-stamp-rounding-minutes)
2573   (setq org-time-stamp-rounding-minutes
2574         (list org-time-stamp-rounding-minutes
2575               org-time-stamp-rounding-minutes)))
2576
2577 (defcustom org-display-custom-times nil
2578   "Non-nil means overlay custom formats over all time stamps.
2579 The formats are defined through the variable `org-time-stamp-custom-formats'.
2580 To turn this on on a per-file basis, insert anywhere in the file:
2581    #+STARTUP: customtime"
2582   :group 'org-time
2583   :set 'set-default
2584   :type 'sexp)
2585 (make-variable-buffer-local 'org-display-custom-times)
2586
2587 (defcustom org-time-stamp-custom-formats
2588   '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
2589   "Custom formats for time stamps.  See `format-time-string' for the syntax.
2590 These are overlayed over the default ISO format if the variable
2591 `org-display-custom-times' is set.  Time like %H:%M should be at the
2592 end of the second format.  The custom formats are also honored by export
2593 commands, if custom time display is turned on at the time of export."
2594   :group 'org-time
2595   :type 'sexp)
2596
2597 (defun org-time-stamp-format (&optional long inactive)
2598   "Get the right format for a time string."
2599   (let ((f (if long (cdr org-time-stamp-formats)
2600              (car org-time-stamp-formats))))
2601     (if inactive
2602         (concat "[" (substring f 1 -1) "]")
2603       f)))
2604
2605 (defcustom org-time-clocksum-format "%d:%02d"
2606   "The format string used when creating CLOCKSUM lines.
2607 This is also used when org-mode generates a time duration."
2608   :group 'org-time
2609   :type 'string)
2610
2611 (defcustom org-time-clocksum-use-fractional nil
2612   "If non-nil, \\[org-clock-display] uses fractional times.
2613 org-mode generates a time duration."
2614   :group 'org-time
2615   :type 'boolean)
2616
2617 (defcustom org-time-clocksum-fractional-format "%.2f"
2618   "The format string used when creating CLOCKSUM lines, or when
2619 org-mode generates a time duration."
2620   :group 'org-time
2621   :type 'string)
2622
2623 (defcustom org-deadline-warning-days 14
2624   "No. of days before expiration during which a deadline becomes active.
2625 This variable governs the display in sparse trees and in the agenda.
2626 When 0 or negative, it means use this number (the absolute value of it)
2627 even if a deadline has a different individual lead time specified.
2628
2629 Custom commands can set this variable in the options section."
2630   :group 'org-time
2631   :group 'org-agenda-daily/weekly
2632   :type 'integer)
2633
2634 (defcustom org-read-date-prefer-future t
2635   "Non-nil means assume future for incomplete date input from user.
2636 This affects the following situations:
2637 1. The user gives a month but not a year.
2638    For example, if it is April and you enter \"feb 2\", this will be read
2639    as Feb 2, *next* year.  \"May 5\", however, will be this year.
2640 2. The user gives a day, but no month.
2641    For example, if today is the 15th, and you enter \"3\", Org-mode will
2642    read this as the third of *next* month.  However, if you enter \"17\",
2643    it will be considered as *this* month.
2644
2645 If you set this variable to the symbol `time', then also the following
2646 will work:
2647
2648 3. If the user gives a time, but no day.  If the time is before now,
2649    to will be interpreted as tomorrow.
2650
2651 Currently none of this works for ISO week specifications.
2652
2653 When this option is nil, the current day, month and year will always be
2654 used as defaults.
2655
2656 See also `org-agenda-jump-prefer-future'."
2657   :group 'org-time
2658   :type '(choice
2659           (const :tag "Never" nil)
2660           (const :tag "Check month and day" t)
2661           (const :tag "Check month, day, and time" time)))
2662
2663 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
2664   "Should the agenda jump command prefer the future for incomplete dates?
2665 The default is to do the same as configured in `org-read-date-prefer-future'.
2666 But you can also set a deviating value here.
2667 This may t or nil, or the symbol `org-read-date-prefer-future'."
2668   :group 'org-agenda
2669   :group 'org-time
2670   :type '(choice
2671           (const :tag "Use org-read-date-prefer-future"
2672                  org-read-date-prefer-future)
2673           (const :tag "Never" nil)
2674           (const :tag "Always" t)))
2675
2676 (defcustom org-read-date-force-compatible-dates t
2677   "Should date/time prompt force dates that are guaranteed to work in Emacs?
2678
2679 Depending on the system Emacs is running on, certain dates cannot
2680 be represented with the type used internally to represent time.
2681 Dates between 1970-1-1 and 2038-1-1 can always be represented
2682 correctly.  Some systems allow for earlier dates, some for later,
2683 some for both.  One way to find out it to insert any date into an
2684 Org buffer, putting the cursor on the year and hitting S-up and
2685 S-down to test the range.
2686
2687 When this variable is set to t, the date/time prompt will not let
2688 you specify dates outside the 1970-2037 range, so it is certain that
2689 these dates will work in whatever version of Emacs you are
2690 running, and also that you can move a file from one Emacs implementation
2691 to another.  WHenever Org is forcing the year for you, it will display
2692 a message and beep.
2693
2694 When this variable is nil, Org will check if the date is
2695 representable in the specific Emacs implementation you are using.
2696 If not, it will force a year, usually the current year, and beep
2697 to remind you.  Currently this setting is not recommended because
2698 the likelihood that you will open your Org files in an Emacs that
2699 has limited date range is not negligible.
2700
2701 A workaround for this problem is to use diary sexp dates for time
2702 stamps outside of this range."
2703   :group 'org-time
2704   :type 'boolean)
2705
2706 (defcustom org-read-date-display-live t
2707   "Non-nil means display current interpretation of date prompt live.
2708 This display will be in an overlay, in the minibuffer."
2709   :group 'org-time
2710   :type 'boolean)
2711
2712 (defcustom org-read-date-popup-calendar t
2713   "Non-nil means pop up a calendar when prompting for a date.
2714 In the calendar, the date can be selected with mouse-1.  However, the
2715 minibuffer will also be active, and you can simply enter the date as well.
2716 When nil, only the minibuffer will be available."
2717   :group 'org-time
2718   :type 'boolean)
2719 (if (fboundp 'defvaralias)
2720     (defvaralias 'org-popup-calendar-for-date-prompt
2721       'org-read-date-popup-calendar))
2722
2723 (defcustom org-read-date-minibuffer-setup-hook nil
2724   "Hook to be used to set up keys for the date/time interface.
2725 Add key definitions to `minibuffer-local-map', which will be a temporary
2726 copy."
2727   :group 'org-time
2728   :type 'hook)
2729
2730 (defcustom org-extend-today-until 0
2731   "The hour when your day really ends.  Must be an integer.
2732 This has influence for the following applications:
2733 - When switching the agenda to \"today\".  It it is still earlier than
2734   the time given here, the day recognized as TODAY is actually yesterday.
2735 - When a date is read from the user and it is still before the time given
2736   here, the current date and time will be assumed to be yesterday, 23:59.
2737   Also, timestamps inserted in remember templates follow this rule.
2738
2739 IMPORTANT:  This is a feature whose implementation is and likely will
2740 remain incomplete.  Really, it is only here because past midnight seems to
2741 be the favorite working time of John Wiegley :-)"
2742   :group 'org-time
2743   :type 'integer)
2744
2745 (defcustom org-use-effective-time nil
2746   "If non-nil, consider `org-extend-today-until' when creating timestamps.
2747 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2748 \"effective time\" of any timestamps between midnight and 8am will be
2749 23:59 of the previous day."
2750   :group 'boolean
2751   :type 'integer)
2752
2753 (defcustom org-edit-timestamp-down-means-later nil
2754   "Non-nil means S-down will increase the time in a time stamp.
2755 When nil, S-up will increase."
2756   :group 'org-time
2757   :type 'boolean)
2758
2759 (defcustom org-calendar-follow-timestamp-change t
2760   "Non-nil means make the calendar window follow timestamp changes.
2761 When a timestamp is modified and the calendar window is visible, it will be
2762 moved to the new date."
2763   :group 'org-time
2764   :type 'boolean)
2765
2766 (defgroup org-tags nil
2767   "Options concerning tags in Org-mode."
2768   :tag "Org Tags"
2769   :group 'org)
2770
2771 (defcustom org-tag-alist nil
2772   "List of tags allowed in Org-mode files.
2773 When this list is nil, Org-mode will base TAG input on what is already in the
2774 buffer.
2775 The value of this variable is an alist, the car of each entry must be a
2776 keyword as a string, the cdr may be a character that is used to select
2777 that tag through the fast-tag-selection interface.
2778 See the manual for details."
2779   :group 'org-tags
2780   :type '(repeat
2781           (choice
2782            (cons   (string    :tag "Tag name")
2783                    (character :tag "Access char"))
2784            (list :tag "Start radio group"
2785                  (const :startgroup)
2786                  (option (string :tag "Group description")))
2787            (list :tag "End radio group"
2788                  (const :endgroup)
2789                  (option (string :tag "Group description")))
2790            (const :tag "New line" (:newline)))))
2791
2792 (defcustom org-tag-persistent-alist nil
2793   "List of tags that will always appear in all Org-mode files.
2794 This is in addition to any in buffer settings or customizations
2795 of `org-tag-alist'.
2796 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2797 The value of this variable is an alist, the car of each entry must be a
2798 keyword as a string, the cdr may be a character that is used to select
2799 that tag through the fast-tag-selection interface.
2800 See the manual for details.
2801 To disable these tags on a per-file basis, insert anywhere in the file:
2802    #+STARTUP: noptag"
2803   :group 'org-tags
2804   :type '(repeat
2805           (choice
2806            (cons   (string    :tag "Tag name")
2807                    (character :tag "Access char"))
2808            (const :tag "Start radio group" (:startgroup))
2809            (const :tag "End radio group" (:endgroup))
2810            (const :tag "New line" (:newline)))))
2811
2812 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
2813   "If non-nil, always offer completion for all tags of all agenda files.
2814 Instead of customizing this variable directly, you might want to
2815 set it locally for capture buffers, because there no list of
2816 tags in that file can be created dynamically (there are none).
2817
2818   (add-hook 'org-capture-mode-hook
2819             (lambda ()
2820               (set (make-local-variable
2821                     'org-complete-tags-always-offer-all-agenda-tags)
2822                    t)))"
2823   :group 'org-tags
2824   :type 'boolean)
2825
2826 (defvar org-file-tags nil
2827   "List of tags that can be inherited by all entries in the file.
2828 The tags will be inherited if the variable `org-use-tag-inheritance'
2829 says they should be.
2830 This variable is populated from #+FILETAGS lines.")
2831
2832 (defcustom org-use-fast-tag-selection 'auto
2833   "Non-nil means use fast tag selection scheme.
2834 This is a special interface to select and deselect tags with single keys.
2835 When nil, fast selection is never used.
2836 When the symbol `auto', fast selection is used if and only if selection
2837 characters for tags have been configured, either through the variable
2838 `org-tag-alist' or through a #+TAGS line in the buffer.
2839 When t, fast selection is always used and selection keys are assigned
2840 automatically if necessary."
2841   :group 'org-tags
2842   :type '(choice
2843           (const :tag "Always" t)
2844           (const :tag "Never" nil)
2845           (const :tag "When selection characters are configured" 'auto)))
2846
2847 (defcustom org-fast-tag-selection-single-key nil
2848   "Non-nil means fast tag selection exits after first change.
2849 When nil, you have to press RET to exit it.
2850 During fast tag selection, you can toggle this flag with `C-c'.
2851 This variable can also have the value `expert'.  In this case, the window
2852 displaying the tags menu is not even shown, until you press C-c again."
2853   :group 'org-tags
2854   :type '(choice
2855           (const :tag "No" nil)
2856           (const :tag "Yes" t)
2857           (const :tag "Expert" expert)))
2858
2859 (defvar org-fast-tag-selection-include-todo nil
2860   "Non-nil means fast tags selection interface will also offer TODO states.
2861 This is an undocumented feature, you should not rely on it.")
2862
2863 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
2864   "The column to which tags should be indented in a headline.
2865 If this number is positive, it specifies the column.  If it is negative,
2866 it means that the tags should be flushright to that column.  For example,
2867 -80 works well for a normal 80 character screen."
2868   :group 'org-tags
2869   :type 'integer)
2870
2871 (defcustom org-auto-align-tags t
2872   "Non-nil keeps tags aligned when modifying headlines.
2873 Some operations (i.e. demoting) change the length of a headline and
2874 therefore shift the tags around.  With this option turned on, after
2875 each such operation the tags are again aligned to `org-tags-column'."
2876   :group 'org-tags
2877   :type 'boolean)
2878
2879 (defcustom org-use-tag-inheritance t
2880   "Non-nil means tags in levels apply also for sublevels.
2881 When nil, only the tags directly given in a specific line apply there.
2882 This may also be a list of tags that should be inherited, or a regexp that
2883 matches tags that should be inherited.  Additional control is possible
2884 with the variable  `org-tags-exclude-from-inheritance' which gives an
2885 explicit list of tags to be excluded from inheritance., even if the value of
2886 `org-use-tag-inheritance' would select it for inheritance.
2887
2888 If this option is t, a match early-on in a tree can lead to a large
2889 number of matches in the subtree when constructing the agenda or creating
2890 a sparse tree.  If you only want to see the first match in a tree during
2891 a search, check out the variable `org-tags-match-list-sublevels'."
2892   :group 'org-tags
2893   :type '(choice
2894           (const :tag "Not" nil)
2895           (const :tag "Always" t)
2896           (repeat :tag "Specific tags" (string :tag "Tag"))
2897           (regexp :tag "Tags matched by regexp")))
2898
2899 (defcustom org-tags-exclude-from-inheritance nil
2900   "List of tags that should never be inherited.
2901 This is a way to exclude a few tags from inheritance.  For way to do
2902 the opposite, to actively allow inheritance for selected tags,
2903 see the variable `org-use-tag-inheritance'."
2904   :group 'org-tags
2905   :type '(repeat (string :tag "Tag")))
2906
2907 (defun org-tag-inherit-p (tag)
2908   "Check if TAG is one that should be inherited."
2909   (cond
2910    ((member tag org-tags-exclude-from-inheritance) nil)
2911    ((eq org-use-tag-inheritance t) t)
2912    ((not org-use-tag-inheritance) nil)
2913    ((stringp org-use-tag-inheritance)
2914     (string-match org-use-tag-inheritance tag))
2915    ((listp org-use-tag-inheritance)
2916     (member tag org-use-tag-inheritance))
2917    (t (error "Invalid setting of `org-use-tag-inheritance'"))))
2918
2919 (defcustom org-tags-match-list-sublevels t
2920   "Non-nil means list also sublevels of headlines matching a search.
2921 This variable applies to tags/property searches, and also to stuck
2922 projects because this search is based on a tags match as well.
2923
2924 When set to the symbol `indented', sublevels are indented with
2925 leading dots.
2926
2927 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2928 the sublevels of a headline matching a tag search often also match
2929 the same search.  Listing all of them can create very long lists.
2930 Setting this variable to nil causes subtrees of a match to be skipped.
2931
2932 This variable is semi-obsolete and probably should always be true.  It
2933 is better to limit inheritance to certain tags using the variables
2934 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2935   :group 'org-tags
2936   :type '(choice
2937           (const :tag "No, don't list them" nil)
2938           (const :tag "Yes, do list them" t)
2939           (const :tag "List them, indented with leading dots" indented)))
2940
2941 (defcustom org-tags-sort-function nil
2942   "When set, tags are sorted using this function as a comparator."
2943   :group 'org-tags
2944   :type '(choice
2945           (const :tag "No sorting" nil)
2946           (const :tag "Alphabetical" string<)
2947           (const :tag "Reverse alphabetical" string>)
2948           (function :tag "Custom function" nil)))
2949
2950 (defvar org-tags-history nil
2951   "History of minibuffer reads for tags.")
2952 (defvar org-last-tags-completion-table nil
2953   "The last used completion table for tags.")
2954 (defvar org-after-tags-change-hook nil
2955   "Hook that is run after the tags in a line have changed.")
2956
2957 (defgroup org-properties nil
2958   "Options concerning properties in Org-mode."
2959   :tag "Org Properties"
2960   :group 'org)
2961
2962 (defcustom org-property-format "%-10s %s"
2963   "How property key/value pairs should be formatted by `indent-line'.
2964 When `indent-line' hits a property definition, it will format the line
2965 according to this format, mainly to make sure that the values are
2966 lined-up with respect to each other."
2967   :group 'org-properties
2968   :type 'string)
2969
2970 (defcustom org-properties-postprocess-alist nil
2971   "Alist of properties and functions to adjust inserted values.
2972 Elements of this alist must be of the form 
2973
2974   ([string] [function])
2975
2976 where [string] must be a property name and [function] must be a
2977 lambda expression: this lambda expression must take one argument,
2978 the value to adjust, and return the new value as a string.
2979
2980 For example, this element will allow the property \"Remaining\"
2981 to be updated wrt the relation between the \"Effort\" property
2982 and the clock summary:
2983
2984  ((\"Remaining\" (lambda(value)
2985                    (let ((clocksum (org-clock-sum-current-item))
2986                          (effort (org-duration-string-to-minutes 
2987                                    (org-entry-get (point) \"Effort\"))))
2988                      (org-minutes-to-hh:mm-string (- effort clocksum))))))"
2989   :group 'org-properties
2990   :type 'alist)
2991
2992 (defcustom org-use-property-inheritance nil
2993   "Non-nil means properties apply also for sublevels.
2994
2995 This setting is chiefly used during property searches.  Turning it on can
2996 cause significant overhead when doing a search, which is why it is not
2997 on by default.
2998
2999 When nil, only the properties directly given in the current entry count.
3000 When t, every property is inherited.  The value may also be a list of
3001 properties that should have inheritance, or a regular expression matching
3002 properties that should be inherited.
3003
3004 However, note that some special properties use inheritance under special
3005 circumstances (not in searches).  Examples are CATEGORY, ARCHIVE, COLUMNS,
3006 and the properties ending in \"_ALL\" when they are used as descriptor
3007 for valid values of a property.
3008
3009 Note for programmers:
3010 When querying an entry with `org-entry-get',  you can control if inheritance
3011 should be used.  By default, `org-entry-get' looks only at the local
3012 properties.  You can request inheritance by setting the inherit argument
3013 to t (to force inheritance) or to `selective' (to respect the setting
3014 in this variable)."
3015   :group 'org-properties
3016   :type '(choice
3017           (const :tag "Not" nil)
3018           (const :tag "Always" t)
3019           (repeat :tag "Specific properties" (string :tag "Property"))
3020           (regexp :tag "Properties matched by regexp")))
3021
3022 (defun org-property-inherit-p (property)
3023   "Check if PROPERTY is one that should be inherited."
3024   (cond
3025    ((eq org-use-property-inheritance t) t)
3026    ((not org-use-property-inheritance) nil)
3027    ((stringp org-use-property-inheritance)
3028     (string-match org-use-property-inheritance property))
3029    ((listp org-use-property-inheritance)
3030     (member property org-use-property-inheritance))
3031    (t (error "Invalid setting of `org-use-property-inheritance'"))))
3032
3033 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3034   "The default column format, if no other format has been defined.
3035 This variable can be set on the per-file basis by inserting a line
3036
3037 #+COLUMNS: %25ITEM ....."
3038   :group 'org-properties
3039   :type 'string)
3040
3041 (defcustom org-columns-ellipses ".."
3042   "The ellipses to be used when a field in column view is truncated.
3043 When this is the empty string, as many characters as possible are shown,
3044 but then there will be no visual indication that the field has been truncated.
3045 When this is a string of length N, the last N characters of a truncated
3046 field are replaced by this string.  If the column is narrower than the
3047 ellipses string, only part of the ellipses string will be shown."
3048   :group 'org-properties
3049   :type 'string)
3050
3051 (defcustom org-columns-modify-value-for-display-function nil
3052   "Function that modifies values for display in column view.
3053 For example, it can be used to cut out a certain part from a time stamp.
3054 The function must take 2 arguments:
3055
3056 column-title    The title of the column (*not* the property name)
3057 value           The value that should be modified.
3058
3059 The function should return the value that should be displayed,
3060 or nil if the normal value should be used."
3061   :group 'org-properties
3062   :type 'function)
3063
3064 (defcustom org-effort-property "Effort"
3065   "The property that is being used to keep track of effort estimates.
3066 Effort estimates given in this property need to have the format H:MM."
3067   :group 'org-properties
3068   :group 'org-progress
3069   :type '(string :tag "Property"))
3070
3071 (defconst org-global-properties-fixed
3072   '(("VISIBILITY_ALL" . "folded children content all")
3073     ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3074   "List of property/value pairs that can be inherited by any entry.
3075
3076 These are fixed values, for the preset properties.  The user variable
3077 that can be used to add to this list is `org-global-properties'.
3078
3079 The entries in this list are cons cells where the car is a property
3080 name and cdr is a string with the value.  If the value represents
3081 multiple items like an \"_ALL\" property, separate the items by
3082 spaces.")
3083
3084 (defcustom org-global-properties nil
3085   "List of property/value pairs that can be inherited by any entry.
3086
3087 This list will be combined with the constant `org-global-properties-fixed'.
3088
3089 The entries in this list are cons cells where the car is a property
3090 name and cdr is a string with the value.
3091
3092 You can set buffer-local values for the same purpose in the variable
3093 `org-file-properties' this by adding lines like
3094
3095 #+PROPERTY: NAME VALUE"
3096   :group 'org-properties
3097   :type '(repeat
3098           (cons (string :tag "Property")
3099                 (string :tag "Value"))))
3100
3101 (defvar org-file-properties nil
3102   "List of property/value pairs that can be inherited by any entry.
3103 Valid for the current buffer.
3104 This variable is populated from #+PROPERTY lines.")
3105 (make-variable-buffer-local 'org-file-properties)
3106
3107 (defgroup org-agenda nil
3108   "Options concerning agenda views in Org-mode."
3109   :tag "Org Agenda"
3110   :group 'org)
3111
3112 (defvar org-category nil
3113   "Variable used by org files to set a category for agenda display.
3114 Such files should use a file variable to set it, for example
3115
3116 #   -*- mode: org; org-category: \"ELisp\"
3117
3118 or contain a special line
3119
3120 #+CATEGORY: ELisp
3121
3122 If the file does not specify a category, then file's base name
3123 is used instead.")
3124 (make-variable-buffer-local 'org-category)
3125 (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
3126
3127 (defcustom org-agenda-files nil
3128   "The files to be used for agenda display.
3129 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3130 \\[org-remove-file].  You can also use customize to edit the list.
3131
3132 If an entry is a directory, all files in that directory that are matched by
3133 `org-agenda-file-regexp' will be part of the file list.
3134
3135 If the value of the variable is not a list but a single file name, then
3136 the list of agenda files is actually stored and maintained in that file, one
3137 agenda file per line.  In this file paths can be given relative to
3138 `org-directory'.  Tilde expansion and environment variable substitution
3139 are also made."
3140   :group 'org-agenda
3141   :type '(choice
3142           (repeat :tag "List of files and directories" file)
3143           (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3144
3145 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3146   "Regular expression to match files for `org-agenda-files'.
3147 If any element in the list in that variable contains a directory instead
3148 of a normal file, all files in that directory that are matched by this
3149 regular expression will be included."
3150   :group 'org-agenda
3151   :type 'regexp)
3152
3153 (defcustom org-agenda-text-search-extra-files nil
3154   "List of extra files to be searched by text search commands.
3155 These files will be search in addition to the agenda files by the
3156 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3157 Note that these files will only be searched for text search commands,
3158 not for the other agenda views like todo lists, tag searches or the weekly
3159 agenda.  This variable is intended to list notes and possibly archive files
3160 that should also be searched by these two commands.
3161 In fact, if the first element in the list is the symbol `agenda-archives',
3162 than all archive files of all agenda files will be added to the search
3163 scope."
3164   :group 'org-agenda
3165   :type '(set :greedy t
3166            (const :tag "Agenda Archives" agenda-archives)
3167            (repeat :inline t (file))))
3168
3169 (if (fboundp 'defvaralias)
3170     (defvaralias 'org-agenda-multi-occur-extra-files
3171       'org-agenda-text-search-extra-files))
3172
3173 (defcustom org-agenda-skip-unavailable-files nil
3174   "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3175 A nil value means to remove them, after a query, from the list."
3176   :group 'org-agenda
3177   :type 'boolean)
3178
3179 (defcustom org-calendar-to-agenda-key [?c]
3180   "The key to be installed in `calendar-mode-map' for switching to the agenda.
3181 The command `org-calendar-goto-agenda' will be bound to this key.  The
3182 default is the character `c' because then `c' can be used to switch back and
3183 forth between agenda and calendar."
3184   :group 'org-agenda
3185   :type 'sexp)
3186
3187 (defcustom org-calendar-agenda-action-key [?k]
3188   "The key to be installed in `calendar-mode-map' for agenda-action.
3189 The command `org-agenda-action' will be bound to this key.  The
3190 default is the character `k' because we use the same key in the agenda."
3191   :group 'org-agenda
3192   :type 'sexp)
3193
3194 (defcustom org-calendar-insert-diary-entry-key [?i]
3195   "The key to be installed in `calendar-mode-map' for adding diary entries.
3196 This option is irrelevant until `org-agenda-diary-file' has been configured
3197 to point to an Org-mode file.  When that is the case, the command
3198 `org-agenda-diary-entry' will be bound to the key given here, by default
3199 `i'.  In the calendar, `i' normally adds entries to `diary-file'.  So
3200 if you want to continue doing this, you need to change this to a different
3201 key."
3202   :group 'org-agenda
3203   :type 'sexp)
3204
3205 (defcustom org-agenda-diary-file 'diary-file
3206   "File to which to add new entries with the `i' key in agenda and calendar.
3207 When this is the symbol `diary-file', the functionality in the Emacs
3208 calendar will be used to add entries to the `diary-file'.  But when this
3209 points to a file, `org-agenda-diary-entry' will be used instead."
3210   :group 'org-agenda
3211   :type '(choice
3212           (const :tag "The standard Emacs diary file" diary-file)
3213           (file :tag "Special Org file diary entries")))
3214
3215 (eval-after-load "calendar"
3216   '(progn
3217      (org-defkey calendar-mode-map org-calendar-to-agenda-key
3218                  'org-calendar-goto-agenda)
3219      (org-defkey calendar-mode-map org-calendar-agenda-action-key
3220                  'org-agenda-action)
3221      (add-hook 'calendar-mode-hook
3222                (lambda ()
3223                  (unless (eq org-agenda-diary-file 'diary-file)
3224                    (define-key calendar-mode-map
3225                      org-calendar-insert-diary-entry-key
3226                      'org-agenda-diary-entry))))))
3227
3228 (defgroup org-latex nil
3229   "Options for embedding LaTeX code into Org-mode."
3230   :tag "Org LaTeX"
3231   :group 'org)
3232
3233 (defcustom org-format-latex-options
3234   '(:foreground default :background default :scale 1.0
3235     :html-foreground "Black" :html-background "Transparent"
3236     :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3237   "Options for creating images from LaTeX fragments.
3238 This is a property list with the following properties:
3239 :foreground  the foreground color for images embedded in Emacs, e.g. \"Black\".
3240              `default' means use the foreground of the default face.
3241 :background  the background color, or \"Transparent\".
3242              `default' means use the background of the default face.
3243 :scale       a scaling factor for the size of the images, to get more pixels
3244 :html-foreground, :html-background, :html-scale
3245              the same numbers for HTML export.
3246 :matchers    a list indicating which matchers should be used to
3247              find LaTeX fragments.  Valid members of this list are:
3248              \"begin\"  find environments
3249              \"$1\"     find single characters surrounded by $.$
3250              \"$\"      find math expressions surrounded by $...$
3251              \"$$\"     find math expressions surrounded by $$....$$
3252              \"\\(\"     find math expressions surrounded by \\(...\\)
3253              \"\\ [\"    find math expressions surrounded by \\ [...\\]"
3254   :group 'org-latex
3255   :type 'plist)
3256
3257 (defcustom org-format-latex-signal-error t
3258   "Non-nil means signal an error when image creation of LaTeX snippets fails.
3259 When nil, just push out a message."
3260   :group 'org-latex
3261   :type 'boolean)
3262
3263 (defcustom org-format-latex-header "\\documentclass{article}
3264 \\usepackage[usenames]{color}
3265 \\usepackage{amsmath}
3266 \\usepackage[mathscr]{eucal}
3267 \\pagestyle{empty}             % do not remove
3268 \[PACKAGES]
3269 \[DEFAULT-PACKAGES]
3270 % The settings below are copied from fullpage.sty
3271 \\setlength{\\textwidth}{\\paperwidth}
3272 \\addtolength{\\textwidth}{-3cm}
3273 \\setlength{\\oddsidemargin}{1.5cm}
3274 \\addtolength{\\oddsidemargin}{-2.54cm}
3275 \\setlength{\\evensidemargin}{\\oddsidemargin}
3276 \\setlength{\\textheight}{\\paperheight}
3277 \\addtolength{\\textheight}{-\\headheight}
3278 \\addtolength{\\textheight}{-\\headsep}
3279 \\addtolength{\\textheight}{-\\footskip}
3280 \\addtolength{\\textheight}{-3cm}
3281 \\setlength{\\topmargin}{1.5cm}
3282 \\addtolength{\\topmargin}{-2.54cm}"
3283   "The document header used for processing LaTeX fragments.
3284 It is imperative that this header make sure that no page number
3285 appears on the page.  The package defined in the variables
3286 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3287 will either replace the placeholder \"[PACKAGES]\" in this header, or they
3288 will be appended."
3289   :group 'org-latex
3290   :type 'string)
3291
3292 (defvar org-format-latex-header-extra nil)
3293
3294 (defun org-set-packages-alist (var val)
3295   "Set the packages alist and make sure it has 3 elements per entry."
3296   (set var (mapcar (lambda (x)
3297                      (if (and (consp x) (= (length x) 2))
3298                          (list (car x) (nth 1 x) t)
3299                        x))
3300                    val)))
3301
3302 (defun org-get-packages-alist (var)
3303
3304   "Get the packages alist and make sure it has 3 elements per entry."
3305   (mapcar (lambda (x)
3306             (if (and (consp x) (= (length x) 2))
3307                 (list (car x) (nth 1 x) t)
3308               x))
3309           (default-value var)))
3310
3311 ;; The following variables are defined here because is it also used
3312 ;; when formatting latex fragments.  Originally it was part of the
3313 ;; LaTeX exporter, which is why the name includes "export".
3314 (defcustom org-export-latex-default-packages-alist
3315   '(("AUTO" "inputenc"  t)
3316     ("T1"   "fontenc"   t)
3317     (""     "fixltx2e"  nil)
3318     (""     "graphicx"  t)
3319     (""     "longtable" nil)
3320     (""     "float"     nil)
3321     (""     "wrapfig"   nil)
3322     (""     "soul"      t)
3323     (""     "textcomp"  t)
3324     (""     "marvosym"  t)
3325     (""     "wasysym"   t)
3326     (""     "latexsym"  t)
3327     (""     "amssymb"   t)
3328     (""     "hyperref"  nil)
3329     "\\tolerance=1000"
3330     )
3331   "Alist of default packages to be inserted in the header.
3332 Change this only if one of the packages here causes an incompatibility
3333 with another package you are using.
3334 The packages in this list are needed by one part or another of Org-mode
3335 to function properly.
3336
3337 - inputenc, fontenc:  for basic font and character selection
3338 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3339   for interpreting the entities in `org-entities'.  You can skip some of these
3340   packages if you don't use any of the symbols in it.
3341 - graphicx: for including images
3342 - float, wrapfig: for figure placement
3343 - longtable: for long tables
3344 - hyperref: for cross references
3345
3346 Therefore you should not modify this variable unless you know what you
3347 are doing.  The one reason to change it anyway is that you might be loading
3348 some other package that conflicts with one of the default packages.
3349 Each cell is of the format \( \"options\" \"package\" snippet-flag\).
3350 If SNIPPET-FLAG is t, the package also needs to be included when
3351 compiling LaTeX snippets into images for inclusion into HTML."
3352   :group 'org-export-latex
3353   :set 'org-set-packages-alist
3354   :get 'org-get-packages-alist
3355   :type '(repeat
3356           (choice
3357            (list :tag "options/package pair"
3358                  (string :tag "options")
3359                  (string :tag "package")
3360                  (boolean :tag "Snippet"))
3361            (string :tag "A line of LaTeX"))))
3362
3363 (defcustom org-export-latex-packages-alist nil
3364   "Alist of packages to be inserted in every LaTeX header.
3365 These will be inserted after `org-export-latex-default-packages-alist'.
3366 Each cell is of the format \( \"options\" \"package\" snippet-flag \).
3367 SNIPPET-FLAG, when t, indicates that this package is also needed when
3368 turning LaTeX snippets into images for inclusion into HTML.
3369 Make sure that you only list packages here which:
3370 - you want in every file
3371 - do not conflict with the default packages in
3372   `org-export-latex-default-packages-alist'
3373 - do not conflict with the setup in `org-format-latex-header'."
3374   :group 'org-export-latex
3375   :set 'org-set-packages-alist
3376   :get 'org-get-packages-alist
3377   :type '(repeat
3378           (choice
3379            (list :tag "options/package pair"
3380                  (string :tag "options")
3381                  (string :tag "package")
3382                  (boolean :tag "Snippet"))
3383            (string :tag "A line of LaTeX"))))
3384
3385
3386 (defgroup org-appearance nil
3387   "Settings for Org-mode appearance."
3388   :tag "Org Appearance"
3389   :group 'org)
3390
3391 (defcustom org-level-color-stars-only nil
3392   "Non-nil means fontify only the stars in each headline.
3393 When nil, the entire headline is fontified.
3394 Changing it requires restart of `font-lock-mode' to become effective
3395 also in regions already fontified."
3396   :group 'org-appearance
3397   :type 'boolean)
3398
3399 (defcustom org-hide-leading-stars nil
3400   "Non-nil means hide the first N-1 stars in a headline.
3401 This works by using the face `org-hide' for these stars.  This
3402 face is white for a light background, and black for a dark
3403 background.  You may have to customize the face `org-hide' to
3404 make this work.
3405 Changing it requires restart of `font-lock-mode' to become effective
3406 also in regions already fontified.
3407 You may also set this on a per-file basis by adding one of the following
3408 lines to the buffer:
3409
3410    #+STARTUP: hidestars
3411    #+STARTUP: showstars"
3412   :group 'org-appearance
3413   :type 'boolean)
3414
3415 (defcustom org-hidden-keywords nil
3416   "List of symbols corresponding to keywords to be hidden the org buffer.
3417 For example, a value '(title) for this list will make the document's title
3418 appear in the buffer without the initial #+TITLE: keyword."
3419   :group 'org-appearance
3420   :type '(set (const :tag "#+AUTHOR" author)
3421               (const :tag "#+DATE" date)
3422               (const :tag "#+EMAIL" email)
3423               (const :tag "#+TITLE" title)))
3424
3425 (defcustom org-fontify-done-headline nil
3426   "Non-nil means change the face of a headline if it is marked DONE.
3427 Normally, only the TODO/DONE keyword indicates the state of a headline.
3428 When this is non-nil, the headline after the keyword is set to the
3429 `org-headline-done' as an additional indication."
3430   :group 'org-appearance
3431   :type 'boolean)
3432
3433 (defcustom org-fontify-emphasized-text t
3434   "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3435 Changing this variable requires a restart of Emacs to take effect."
3436   :group 'org-appearance
3437   :type 'boolean)
3438
3439 (defcustom org-fontify-whole-heading-line nil
3440   "Non-nil means fontify the whole line for headings.
3441 This is useful when setting a background color for the
3442 org-level-* faces."
3443   :group 'org-appearance
3444   :type 'boolean)
3445
3446 (defcustom org-highlight-latex-fragments-and-specials nil
3447   "Non-nil means fontify what is treated specially by the exporters."
3448   :group 'org-appearance
3449   :type 'boolean)
3450
3451 (defcustom org-hide-emphasis-markers nil
3452   "Non-nil mean font-lock should hide the emphasis marker characters."
3453   :group 'org-appearance
3454   :type 'boolean)
3455
3456 (defcustom org-pretty-entities nil
3457   "Non-nil means show entities as UTF8 characters.
3458 When nil, the \\name form remains in the buffer."
3459   :group 'org-appearance
3460   :type 'boolean)
3461
3462 (defcustom org-pretty-entities-include-sub-superscripts t
3463   "Non-nil means, pretty entity display includes formatting sub/superscripts."
3464   :group 'org-appearance
3465   :type 'boolean)
3466
3467 (defvar org-emph-re nil
3468   "Regular expression for matching emphasis.
3469 After a match, the match groups contain these elements:
3470 0  The match of the full regular expression, including the characters
3471      before and after the proper match
3472 1  The character before the proper match, or empty at beginning of line
3473 2  The proper match, including the leading and trailing markers
3474 3  The leading marker like * or /, indicating the type of highlighting
3475 4  The text between the emphasis markers, not including the markers
3476 5  The character after the match, empty at the end of a line")
3477 (defvar org-verbatim-re nil
3478   "Regular expression for matching verbatim text.")
3479 (defvar org-emphasis-regexp-components) ; defined just below
3480 (defvar org-emphasis-alist) ; defined just below
3481 (defun org-set-emph-re (var val)
3482   "Set variable and compute the emphasis regular expression."
3483   (set var val)
3484   (when (and (boundp 'org-emphasis-alist)
3485              (boundp 'org-emphasis-regexp-components)
3486              org-emphasis-alist org-emphasis-regexp-components)
3487     (let* ((e org-emphasis-regexp-components)
3488            (pre (car e))
3489            (post (nth 1 e))
3490            (border (nth 2 e))
3491            (body (nth 3 e))
3492            (nl (nth 4 e))
3493            (body1 (concat body "*?"))
3494            (markers (mapconcat 'car org-emphasis-alist ""))
3495            (vmarkers (mapconcat
3496                       (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
3497                       org-emphasis-alist "")))
3498       ;; make sure special characters appear at the right position in the class
3499       (if (string-match "\\^" markers)
3500           (setq markers (concat (replace-match "" t t markers) "^")))
3501       (if (string-match "-" markers)
3502           (setq markers (concat (replace-match "" t t markers) "-")))
3503       (if (string-match "\\^" vmarkers)
3504           (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
3505       (if (string-match "-" vmarkers)
3506           (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
3507       (if (> nl 0)
3508           (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
3509                               (int-to-string nl) "\\}")))
3510       ;; Make the regexp
3511       (setq org-emph-re
3512             (concat "\\([" pre "]\\|^\\)"
3513                     "\\("
3514                     "\\([" markers "]\\)"
3515                     "\\("
3516                     "[^" border "]\\|"
3517                     "[^" border "]"
3518                     body1
3519                     "[^" border "]"
3520                     "\\)"
3521                     "\\3\\)"
3522                     "\\([" post "]\\|$\\)"))
3523       (setq org-verbatim-re
3524             (concat "\\([" pre "]\\|^\\)"
3525                     "\\("
3526                     "\\([" vmarkers "]\\)"
3527                     "\\("
3528                     "[^" border "]\\|"
3529                     "[^" border "]"
3530                     body1
3531                     "[^" border "]"
3532                     "\\)"
3533                     "\\3\\)"
3534                     "\\([" post  "]\\|$\\)")))))
3535
3536 (defcustom org-emphasis-regexp-components
3537   '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
3538   "Components used to build the regular expression for emphasis.
3539 This is a list with five entries.  Terminology:  In an emphasis string
3540 like \" *strong word* \", we call the initial space PREMATCH, the final
3541 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
3542 and \"trong wor\" is the body.  The different components in this variable
3543 specify what is allowed/forbidden in each part:
3544
3545 pre          Chars allowed as prematch.  Beginning of line will be allowed too.
3546 post         Chars allowed as postmatch.  End of line will be allowed too.
3547 border       The chars *forbidden* as border characters.
3548 body-regexp  A regexp like \".\" to match a body character.  Don't use
3549              non-shy groups here, and don't allow newline here.
3550 newline      The maximum number of newlines allowed in an emphasis exp.
3551
3552 Use customize to modify this, or restart Emacs after changing it."
3553   :group 'org-appearance
3554   :set 'org-set-emph-re
3555   :type '(list
3556           (sexp    :tag "Allowed chars in pre      ")
3557           (sexp    :tag "Allowed chars in post     ")
3558           (sexp    :tag "Forbidden chars in border ")
3559           (sexp    :tag "Regexp for body           ")
3560           (integer :tag "number of newlines allowed")
3561           (option (boolean :tag "Please ignore this button"))))
3562
3563 (defcustom org-emphasis-alist
3564   `(("*" bold "<b>" "</b>")
3565     ("/" italic "<i>" "</i>")
3566     ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
3567     ("=" org-code "<code>" "</code>" verbatim)
3568     ("~" org-verbatim "<code>" "</code>" verbatim)
3569     ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
3570      "<del>" "</del>")
3571     )
3572   "Special syntax for emphasized text.
3573 Text starting and ending with a special character will be emphasized, for
3574 example *bold*, _underlined_ and /italic/.  This variable sets the marker
3575 characters, the face to be used by font-lock for highlighting in Org-mode
3576 Emacs buffers, and the HTML tags to be used for this.
3577 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3578 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3579 Use customize to modify this, or restart Emacs after changing it."
3580   :group 'org-appearance
3581   :set 'org-set-emph-re
3582   :type '(repeat
3583           (list
3584            (string :tag "Marker character")
3585            (choice
3586             (face :tag "Font-lock-face")
3587             (plist :tag "Face property list"))
3588            (string :tag "HTML start tag")
3589            (string :tag "HTML end tag")
3590            (option (const verbatim)))))
3591
3592 (defvar org-protecting-blocks
3593   '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
3594   "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3595 This is needed for font-lock setup.")
3596
3597 ;;; Miscellaneous options
3598
3599 (defgroup org-completion nil
3600   "Completion in Org-mode."
3601   :tag "Org Completion"
3602   :group 'org)
3603
3604 (defcustom org-completion-use-ido nil
3605   "Non-nil means use ido completion wherever possible.
3606 Note that `ido-mode' must be active for this variable to be relevant.
3607 If you decide to turn this variable on, you might well want to turn off
3608 `org-outline-path-complete-in-steps'.
3609 See also `org-completion-use-iswitchb'."
3610   :group 'org-completion
3611   :type 'boolean)
3612
3613 (defcustom org-completion-use-iswitchb nil
3614   "Non-nil means use iswitchb completion wherever possible.
3615 Note that `iswitchb-mode' must be active for this variable to be relevant.
3616 If you decide to turn this variable on, you might well want to turn off
3617 `org-outline-path-complete-in-steps'.
3618 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3619   :group 'org-completion
3620   :type 'boolean)
3621
3622 (defcustom org-completion-fallback-command 'hippie-expand
3623   "The expansion command called by \\[pcomplete] in normal context.
3624 Normal means, no org-mode-specific context."
3625   :group 'org-completion
3626   :type 'function)
3627
3628 ;;; Functions and variables from their packages
3629 ;;  Declared here to avoid compiler warnings
3630
3631 ;; XEmacs only
3632 (defvar outline-mode-menu-heading)
3633 (defvar outline-mode-menu-show)
3634 (defvar outline-mode-menu-hide)
3635 (defvar zmacs-regions) ; XEmacs regions
3636
3637 ;; Emacs only
3638 (defvar mark-active)
3639
3640 ;; Various packages
3641 (declare-function calendar-absolute-from-iso    "cal-iso"    (date))
3642 (declare-function calendar-forward-d