lisp/textmodes/org.el

148 When the function `org-mode' is called interactively in an empty file, this
401 The function(s) in this hook must accept a single argument which indicates
869 also be a function that will be called with the tag as the only argument to
1077 This is a list with the first element being a lisp function, and the
1078 remaining elements being arguments to the function.  In string arguments,
1086 	  (cons :tag "other" (function) (repeat :tag "argument" sexp))))
1088 (defcustom org-confirm-shell-link-function 'yes-or-no-p
1105 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
1717 		  (symbol :tag "Other, user-defined function"))
1750 		   (list :tag "Other, user-defined function"
1751 			 (symbol :tag "function")
2243 Note that a numeric prefix argument to an exporter function overrides
2802 (defface org-level-1 ;; font-lock-function-name-face
2957 (defface org-table ;; font-lock-function-name-face
3119 (put 'org-let 'lisp-indent-function 1)
3123 (put 'org-let2 'lisp-indent-function 2)
3286 (defvar org-finish-function nil
3303 (defvar font-lock-unfontify-region-function)
3417 (defun org-add-hook (hook function &optional append local)
3420       (add-local-hook hook function append)
3421     (add-hook hook function append local)))
3470 ;; We use a before-change function to check if a table might need
3474 This variable is set by `org-before-change-function'.
3538   (org-set-local 'font-lock-unfontify-region-function
3540   ;; Activate before-change-function
3542   (org-add-hook 'before-change-functions 'org-before-change-function nil
3556 	  (not (boundp 'outline-isearch-open-invisible-function)))
3560     (org-set-local 'outline-isearch-open-invisible-function
3607 (put 'org-add-props 'lisp-indent-function 2)
4003 - When this function is called with a prefix argument, rotate the entire
4022   `indent-relative', like TAB normally does.  See the option
4026   no headline in line 1, this function will act as if called with prefix arg."
4154       (indent-relative))
4210 This function is the default value of the hook `org-cycle-hook'."
4296 This function uses a recursive edit.  It returns the selected position
4640 	  (indent-to (+ diff col))))
4911 type unless it has been given to the function through the SORTING-TYPE
4987 function does not specify it.  WHAT is only for the prompt, to indicate
5425 (defvar org-last-indent-begin-marker (make-marker))
5426 (defvar org-last-indent-end-marker (make-marker))
5431   (org-indent-item (- arg)))
5433 (defun org-indent-item (arg)
5441 	  (setq beg org-last-indent-begin-marker
5442 		end org-last-indent-end-marker)
5444 	(setq beg (move-marker org-last-indent-begin-marker (point)))
5446 	(setq end (move-marker org-last-indent-end-marker (point))))
5454 	(indent-to-column (+ ind1 arg))
5709 (defun org-before-change-function (beg end)
5804 	 (indent (make-string (current-column) ?\ ))
5808 	 (line (concat (apply 'concat indent "|" (make-list columns "  |"))
5942 	 (indent "") cnt frac
5974 	(setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
6055     (setq rfmt (concat indent "|") hfmt (concat indent "|"))
6702 If SORTING-TYPE is specified when this function is called from a Lisp
6969       (org-set-local 'org-finish-function
7068 (defun org-table-map-tables (function)
7078 	    (save-excursion (funcall function)))
7476 This function makes use of Dave Gillespie's Calc package, in my view the
7478 installed in order to use this function.
7500 This function can also be called from Lisp programs and offers
7505 formula, assuming that this has been done already outside the function.
7937 (define-key org-edit-formulas-map [(meta tab)]    'lisp-complete-symbol)
7938 (define-key org-edit-formulas-map "\M-\C-i"       'lisp-complete-symbol)
7939 (define-key org-edit-formulas-map [(tab)]         'org-edit-formula-lisp-indent)
7940 (define-key org-edit-formulas-map "\C-i"          'org-edit-formula-lisp-indent)
7978   (when (not (memq this-command '(lisp-complete-symbol)))
8026 (defun org-edit-formula-lisp-indent ()
8027   "Pretty-print and re-indent Lisp expressions in the Formula Editor."
8034       (call-interactively 'lisp-indent-line))
8341 ;; function which tests if the cursor is currently inside a table.  If that
8343 ;; those keys is used outside a table, the function uses `key-binding' to
8402 	  (org-add-hook 'before-change-functions 'org-before-change-function
8420       (remove-hook 'before-change-functions 'org-before-change-function t)
8446   "Create a function for binding in the table minor mode.
8473   (error "This key is has no function outside tables"))
8727 	(error "No such transformation function %s" transform))
8798 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
8917 this function is called."
8933 Currently this function recognizes the following parameters:
8939 this function is called.  The function does *not* use `orgtbl-to-generic',
8979 this function is called."
9098 	     (subject (let (wl-thr-indent-string wl-parent-message-entity)
9601 If there is no link at point, this function will search forward up to
9753 	  (if (or (not org-confirm-shell-link-function)
9754 		  (funcall org-confirm-shell-link-function
9765 	  (if (or (not org-confirm-elisp-link-function)
9766 		  (funcall org-confirm-elisp-link-function
9785 A function in the hook should first test if it would like to
9793 taken to make the search successful, another function should be
9797 A function in this hook may also use `setq' to set the variable
9807 double colon.  The function must first check if it would like to
9814 Each function can access the current prefix argument through the
9817 use a numeric or double prefix to guide the search function.
9819 In case this is needed, a function in this hook can also restore
10264 	  (bibtex-autokey-name-case-convert-function 'identity)
10271 	  (bibtex-autokey-titleword-case-convert-function 'identity)
10411 conventions in Org-mode.  This function returns such a link."
10424 This function should be placed into `remember-mode-hook' and in fact requires
10486 	(org-set-local 'org-finish-function 'remember-buffer)
10512     (org-set-local 'org-finish-function 'remember-buffer)))
10520   (if (eq org-finish-function 'remember-buffer)
10558 Before being stored away, the function ensures that the text has a
10579 	   spos level indent reversed)
10587 	    (setq indent nil)
10592 		indent "  "))
10593 	(if (and org-adapt-indentation indent)
10594 	    (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
10760 the correct writing function."
10784 This function can be used in a hook."
10925 For calling through lisp, arg is also interpreted in the following way:
11026 This function should be run in the `org-after-todo-state-change-hook'."
11027   ;; last-state is dynamically scoped into this function
11123 	    (indent-to-column col))
11197   (org-set-local 'org-finish-function 'org-store-log-note))
11230 	(if (not (bolp)) (insert "\n")) (indent-relative nil)
11252 If CALLBACK is non-nil, it is a function which is called to confirm
11333 BEG and END are ignored.  If NOREMOVE is nil, remove this function
11506   ;; todo-only is scoped dynamically into this function, and the function
11514 		 "Match: " 'org-tags-completion-function nil nil nil
11517   ;; Parse the string and create a lisp form
11587     ;; Return the string and lisp forms of the matcher
11635 		     (completing-read "Tags: " 'org-tags-completion-function
11664 (defun org-tags-completion-function (string predicate &optional flag)
11978 The function understands only English month and weekday abbreviations,
11992 enter a time, and this function will inform the calling routine about
12546       (indent-relative)
12694 BEG and END are ignored.  If NOREMOVE is nil, remove this function
13151   (declare (indent 1) (debug t))
13652 (defvar org-agenda-skip-function nil
13654 If this function return nil, the current match should not be skipped.
13655 Otherwise, the function must return a position from where the search
13674     (when (and (functionp org-agenda-skip-function)
13677 			    (funcall org-agenda-skip-function)))))
14162 used by user-defined selections using `org-agenda-skip-function'.")
14170 to skip this subtree.  This is a function that can be put into
14171 `org-agenda-skip-function' for the duration of a command."
14186   (let* ((org-agenda-skip-function 'org-agenda-skip-subtree-when-regexp-matches)
14221 	 (diary-file-name-prefix-function nil) ; turn this feature off
14222 	 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
14276   '(if (boundp 'diary-modify-entry-list-string-function)
14310 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
14312 listed in the diary.  The function accepts arguments specifying what
14348 The function expects the lisp variables `entry' and `date' to be provided
14350 function from a program - use `org-agenda-get-day-entries' instead."
15398 If this information is not given, the function uses the tree at point."
15868 	 (oldf (symbol-function 'calendar-cursor-to-date))
15878     ;; We implement this by hacking the `calendar-cursor-to-date' function
15901   (let* ((oldf (symbol-function 'calendar-cursor-to-date))
16041 Even though the matchers for math are configurable, this function assumes
16047 This function does a reasonably good job, but can locally be fooled by
16051 with the uncertainty caused by missing closing delimiters.  This function
16231 ;; This function borrows from Ganesh Swami's latex2png.el
17394 	 (link-validate (plist-get opt-plist :link-validation-function))
17437 	 (local-list-indent nil)
17762 	      (setq local-list-indent nil
17804 		(setq ind (1+ (or (car local-list-indent) 1))))
17806 			  (or (and (= ind (car local-list-indent))
17808 			      (< ind (car local-list-indent))))
17811 		(pop local-list-num) (pop local-list-indent)
17812 		(setq in-local-list local-list-indent))
17816 			 (> ind (car local-list-indent))))
17821 		(push ind local-list-indent)
17857 	(setq local-list-indent nil
18236       ;; If title is nil, this means this function is called to close
18465 (put 'org-export-as-xoxo-insert-into 'lisp-indent-function 1)
18540       (indent-region (point-min) (point-max) nil)
18724 When deleting backwards, in tables this function will insert whitespace in
18747 When deleting characters, in tables this function will insert whitespace in
18841    ((org-at-item-p) (call-interactively 'org-indent-item))
18890    ((org-at-item-p) (call-interactively 'org-indent-item))
19020      ((and (local-variable-p 'org-finish-function (current-buffer))
19021 	   (fboundp org-finish-function))
19022       (funcall org-finish-function))
19337   "Call the customize function with org as argument."
19389 This function expects the position to be visible because it uses font-lock
19602   ;; We use our own fill-paragraph function, to make sure that tables
19603   ;; and fixed-width regions are not wrapped.  That function will pass
19605   (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19609   (org-set-local 'adaptive-fill-function
19610 		 'org-adaptive-fill-function))
19624 (defun org-adaptive-fill-function ()
19660 to a visible line beginning.  This makes the function of C-a more intuitive."
19699 This function considers both visible and invisible heading lines.
19755   ;; This is an exact copy of the original function, but it uses
19815       ;; (Emacs 22 has a special variable, see function `org-mode')