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