diff options
| author | Juanma Barranquero | 2008-01-21 00:44:43 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2008-01-21 00:44:43 +0000 |
| commit | a0d892d475cbdabda101d2da3111c25efb43e6e0 (patch) | |
| tree | 6ce91046d11f91001e207a2d60dc0e39c51738e6 | |
| parent | 3c2e52cde9960da063b34e7c7abdd08969623f2f (diff) | |
| download | emacs-a0d892d475cbdabda101d2da3111c25efb43e6e0.tar.gz emacs-a0d892d475cbdabda101d2da3111c25efb43e6e0.zip | |
(org-unmodified, org-cycle-emulate-tab, org-descriptive-links,
org-link-file-path-type, org-remember-use-refile-when-interactive,
org-agenda-skip-timestamp-if-done, org-agenda-scheduled-leaders,
org-export-ascii-bullets, org-agenda-deadline-faces, turn-on-orgstruct++,
orgtbl-to-texinfo, org-mhe-get-header, org-batch-agenda, org-batch-agenda-csv,
org-fix-agenda-info, org-kill-note-or-show-branches): Fix typos in docstrings.
| -rw-r--r-- | lisp/textmodes/org.el | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/lisp/textmodes/org.el b/lisp/textmodes/org.el index 9826a5b63a0..75e84e51719 100644 --- a/lisp/textmodes/org.el +++ b/lisp/textmodes/org.el | |||
| @@ -103,7 +103,7 @@ | |||
| 103 | `(and (boundp (quote ,var)) ,var)) | 103 | `(and (boundp (quote ,var)) ,var)) |
| 104 | 104 | ||
| 105 | (defmacro org-unmodified (&rest body) | 105 | (defmacro org-unmodified (&rest body) |
| 106 | "Execute body without changing buffer-modified-p." | 106 | "Execute body without changing `buffer-modified-p'." |
| 107 | `(set-buffer-modified-p | 107 | `(set-buffer-modified-p |
| 108 | (prog1 (buffer-modified-p) ,@body))) | 108 | (prog1 (buffer-modified-p) ,@body))) |
| 109 | 109 | ||
| @@ -454,7 +454,7 @@ of the buffer." | |||
| 454 | "Where should `org-cycle' emulate TAB. | 454 | "Where should `org-cycle' emulate TAB. |
| 455 | nil Never | 455 | nil Never |
| 456 | white Only in completely white lines | 456 | white Only in completely white lines |
| 457 | whitestart Only at the beginning of lines, before the first non-white char. | 457 | whitestart Only at the beginning of lines, before the first non-white char |
| 458 | t Everywhere except in headlines | 458 | t Everywhere except in headlines |
| 459 | exc-hl-bol Everywhere except at the start of a headline | 459 | exc-hl-bol Everywhere except at the start of a headline |
| 460 | If TAB is used in a place where it does not emulate TAB, the current subtree | 460 | If TAB is used in a place where it does not emulate TAB, the current subtree |
| @@ -1046,7 +1046,7 @@ See the manual for examples." | |||
| 1046 | 1046 | ||
| 1047 | (defcustom org-descriptive-links t | 1047 | (defcustom org-descriptive-links t |
| 1048 | "Non-nil means, hide link part and only show description of bracket links. | 1048 | "Non-nil means, hide link part and only show description of bracket links. |
| 1049 | Bracket links are like [[link][descritpion]]. This variable sets the initial | 1049 | Bracket links are like [[link][descritpion]]. This variable sets the initial |
| 1050 | state in new org-mode buffers. The setting can then be toggled on a | 1050 | state in new org-mode buffers. The setting can then be toggled on a |
| 1051 | per-buffer basis from the Org->Hyperlinks menu." | 1051 | per-buffer basis from the Org->Hyperlinks menu." |
| 1052 | :group 'org-link | 1052 | :group 'org-link |
| @@ -1056,10 +1056,10 @@ per-buffer basis from the Org->Hyperlinks menu." | |||
| 1056 | "How the path name in file links should be stored. | 1056 | "How the path name in file links should be stored. |
| 1057 | Valid values are: | 1057 | Valid values are: |
| 1058 | 1058 | ||
| 1059 | relative relative to the current directory, i.e. the directory of the file | 1059 | relative Relative to the current directory, i.e. the directory of the file |
| 1060 | into which the link is being inserted. | 1060 | into which the link is being inserted. |
| 1061 | absolute absolute path, if possible with ~ for home directory. | 1061 | absolute Absolute path, if possible with ~ for home directory. |
| 1062 | noabbrev absolute path, no abbreviation of home directory. | 1062 | noabbrev Absolute path, no abbreviation of home directory. |
| 1063 | adaptive Use relative path for files in the current directory and sub- | 1063 | adaptive Use relative path for files in the current directory and sub- |
| 1064 | directories of it. For other files, use an absolute path." | 1064 | directories of it. For other files, use an absolute path." |
| 1065 | :group 'org-link | 1065 | :group 'org-link |
| @@ -1413,7 +1413,7 @@ When this variable is nil, `C-c C-c' give you the prompts, and | |||
| 1413 | 1413 | ||
| 1414 | (defcustom org-remember-use-refile-when-interactive t | 1414 | (defcustom org-remember-use-refile-when-interactive t |
| 1415 | "Non-nil means, use refile to file a remember note. | 1415 | "Non-nil means, use refile to file a remember note. |
| 1416 | This is only used when the the interactive mode for selecting a filing | 1416 | This is only used when the interactive mode for selecting a filing |
| 1417 | location is used (see the variable `org-remember-store-without-prompt'). | 1417 | location is used (see the variable `org-remember-store-without-prompt'). |
| 1418 | When nil, the `org-goto' interface is used." | 1418 | When nil, the `org-goto' interface is used." |
| 1419 | :group 'org-remember | 1419 | :group 'org-remember |
| @@ -2452,7 +2452,7 @@ deadlines are always turned off when the item is DONE." | |||
| 2452 | :type 'boolean) | 2452 | :type 'boolean) |
| 2453 | 2453 | ||
| 2454 | (defcustom org-agenda-skip-timestamp-if-done nil | 2454 | (defcustom org-agenda-skip-timestamp-if-done nil |
| 2455 | "Non-nil means don't don't select item by timestamp or -range if it is DONE." | 2455 | "Non-nil means don't select item by timestamp or -range if it is DONE." |
| 2456 | :group 'org-agenda-skip | 2456 | :group 'org-agenda-skip |
| 2457 | :type 'boolean) | 2457 | :type 'boolean) |
| 2458 | 2458 | ||
| @@ -2827,7 +2827,7 @@ to occupy a fixed space in the agenda display." | |||
| 2827 | 2827 | ||
| 2828 | (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ") | 2828 | (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ") |
| 2829 | "Text preceeding scheduled items in the agenda view. | 2829 | "Text preceeding scheduled items in the agenda view. |
| 2830 | THis is a list with two strings. The first applies when the item is | 2830 | This is a list with two strings. The first applies when the item is |
| 2831 | scheduled on the current day. The second applies when it has been scheduled | 2831 | scheduled on the current day. The second applies when it has been scheduled |
| 2832 | previously, it may contain a %d to capture how many days ago the item was | 2832 | previously, it may contain a %d to capture how many days ago the item was |
| 2833 | scheduled." | 2833 | scheduled." |
| @@ -3304,7 +3304,7 @@ In the given sequence, these characters will be used for level 1, 2, ..." | |||
| 3304 | 3304 | ||
| 3305 | (defcustom org-export-ascii-bullets '(?* ?+ ?-) | 3305 | (defcustom org-export-ascii-bullets '(?* ?+ ?-) |
| 3306 | "Bullet characters for headlines converted to lists in ASCII export. | 3306 | "Bullet characters for headlines converted to lists in ASCII export. |
| 3307 | The first character is is used for the first lest level generated in this | 3307 | The first character is used for the first lest level generated in this |
| 3308 | way, and so on. If there are more levels than characters given here, | 3308 | way, and so on. If there are more levels than characters given here, |
| 3309 | the list will be repeated. | 3309 | the list will be repeated. |
| 3310 | Note that plain lists will keep the same bullets as the have in the | 3310 | Note that plain lists will keep the same bullets as the have in the |
| @@ -4031,8 +4031,8 @@ list of attributes, like (:foreground \"blue\" :weight bold :underline t)." | |||
| 4031 | (0.5 . org-upcoming-deadline) | 4031 | (0.5 . org-upcoming-deadline) |
| 4032 | (0.0 . default)) | 4032 | (0.0 . default)) |
| 4033 | "Faces for showing deadlines in the agenda. | 4033 | "Faces for showing deadlines in the agenda. |
| 4034 | This is a list of cons cells. The cdr of each cess is a face to be used, | 4034 | This is a list of cons cells. The cdr of each cell is a face to be used, |
| 4035 | and it can also just be a like like '(:foreground \"yellow\"). | 4035 | and it can also just be like '(:foreground \"yellow\"). |
| 4036 | Each car is a fraction of the head-warning time that must have passed for | 4036 | Each car is a fraction of the head-warning time that must have passed for |
| 4037 | this the face in the cdr to be used for display. The numbers must be | 4037 | this the face in the cdr to be used for display. The numbers must be |
| 4038 | given in descending order. The head-warning time is normally taken | 4038 | given in descending order. The head-warning time is normally taken |
| @@ -7205,7 +7205,7 @@ so this really moves item trees." | |||
| 7205 | (let ((kill-whole-line t)) | 7205 | (let ((kill-whole-line t)) |
| 7206 | (kill-line (- ne-ins ne-beg)) (point))) | 7206 | (kill-line (- ne-ins ne-beg)) (point))) |
| 7207 | (insert (make-string (- ne-ins ne-beg) ?\n))) | 7207 | (insert (make-string (- ne-ins ne-beg) ?\n))) |
| 7208 | 7208 | ||
| 7209 | (org-maybe-renumber-ordered-list)) | 7209 | (org-maybe-renumber-ordered-list)) |
| 7210 | (goto-char pos) | 7210 | (goto-char pos) |
| 7211 | (error "Cannot move this item further up")))) | 7211 | (error "Cannot move this item further up")))) |
| @@ -7528,7 +7528,7 @@ C-c C-c Set tags / toggle checkbox" | |||
| 7528 | "Unconditionally turn on `orgstruct-mode', and force org-mode indentations. | 7528 | "Unconditionally turn on `orgstruct-mode', and force org-mode indentations. |
| 7529 | In addition to setting orgstruct-mode, this also exports all indentation and | 7529 | In addition to setting orgstruct-mode, this also exports all indentation and |
| 7530 | autofilling variables from org-mode into the buffer. Note that turning | 7530 | autofilling variables from org-mode into the buffer. Note that turning |
| 7531 | off orgstruct-mode will *not* remove these additonal settings." | 7531 | off orgstruct-mode will *not* remove these additional settings." |
| 7532 | (orgstruct-mode 1) | 7532 | (orgstruct-mode 1) |
| 7533 | (let (var val) | 7533 | (let (var val) |
| 7534 | (mapc | 7534 | (mapc |
| @@ -11659,9 +11659,9 @@ TeXInfo are: | |||
| 11659 | %s for the original field value. For example, to wrap | 11659 | %s for the original field value. For example, to wrap |
| 11660 | everything in @kbd{}, you could use :fmt \"@kbd{%s}\". | 11660 | everything in @kbd{}, you could use :fmt \"@kbd{%s}\". |
| 11661 | This may also be a property list with column numbers and | 11661 | This may also be a property list with column numbers and |
| 11662 | formats. for example :fmt (2 \"@kbd{%s}\" 4 \"@code{%s}\"). | 11662 | formats. For example :fmt (2 \"@kbd{%s}\" 4 \"@code{%s}\"). |
| 11663 | 11663 | ||
| 11664 | :cf \"f1 f2..\" The column fractions for the table. Bye default these | 11664 | :cf \"f1 f2..\" The column fractions for the table. By default these |
| 11665 | are computed automatically from the width of the columns | 11665 | are computed automatically from the width of the columns |
| 11666 | under org-mode. | 11666 | under org-mode. |
| 11667 | 11667 | ||
| @@ -13040,8 +13040,8 @@ use sequences." | |||
| 13040 | (mh-show-buffer-message-number)))) | 13040 | (mh-show-buffer-message-number)))) |
| 13041 | 13041 | ||
| 13042 | (defun org-mhe-get-header (header) | 13042 | (defun org-mhe-get-header (header) |
| 13043 | "Return a header of the message in folder mode. This will create a | 13043 | "Return a header of the message in folder mode. This will create a |
| 13044 | show buffer for the corresponding message. If you have a more clever | 13044 | show buffer for the corresponding message. If you have a more clever |
| 13045 | idea..." | 13045 | idea..." |
| 13046 | (let* ((folder (org-mhe-get-message-folder)) | 13046 | (let* ((folder (org-mhe-get-message-folder)) |
| 13047 | (num (org-mhe-get-message-num)) | 13047 | (num (org-mhe-get-message-num)) |
| @@ -13745,7 +13745,7 @@ See also the variable `org-reverse-note-order'." | |||
| 13745 | (when remember-save-after-remembering | 13745 | (when remember-save-after-remembering |
| 13746 | (save-buffer) | 13746 | (save-buffer) |
| 13747 | (if (not visiting) (kill-buffer (current-buffer))))))))) | 13747 | (if (not visiting) (kill-buffer (current-buffer))))))))) |
| 13748 | 13748 | ||
| 13749 | t) ;; return t to indicate that we took care of this note. | 13749 | t) ;; return t to indicate that we took care of this note. |
| 13750 | 13750 | ||
| 13751 | (defun org-get-org-file () | 13751 | (defun org-get-org-file () |
| @@ -13847,7 +13847,7 @@ See also the variable `org-reverse-note-order'." | |||
| 13847 | (goto-char (point-at-eol)))))))) | 13847 | (goto-char (point-at-eol)))))))) |
| 13848 | (org-release-buffers org-agenda-new-buffers) | 13848 | (org-release-buffers org-agenda-new-buffers) |
| 13849 | (nreverse targets)))) | 13849 | (nreverse targets)))) |
| 13850 | 13850 | ||
| 13851 | (defun org-get-outline-path () | 13851 | (defun org-get-outline-path () |
| 13852 | (let (rtn) | 13852 | (let (rtn) |
| 13853 | (save-excursion | 13853 | (save-excursion |
| @@ -15776,7 +15776,7 @@ If WHICH is nil or `all', get all properties. If WHICH is | |||
| 15776 | (unless (member key excluded) | 15776 | (unless (member key excluded) |
| 15777 | (push (cons key (or value "")) props))))) | 15777 | (push (cons key (or value "")) props))))) |
| 15778 | (if clocksum | 15778 | (if clocksum |
| 15779 | (push (cons "CLOCKSUM" | 15779 | (push (cons "CLOCKSUM" |
| 15780 | (org-column-number-to-string (/ (float clocksum) 60.) | 15780 | (org-column-number-to-string (/ (float clocksum) 60.) |
| 15781 | 'add_times)) | 15781 | 'add_times)) |
| 15782 | props)) | 15782 | props)) |
| @@ -17501,8 +17501,8 @@ user." | |||
| 17501 | "Check string S for special relative date string. | 17501 | "Check string S for special relative date string. |
| 17502 | TODAY and DEFAULT are internal times, for today and for a default. | 17502 | TODAY and DEFAULT are internal times, for today and for a default. |
| 17503 | Return shift list (N what def-flag) | 17503 | Return shift list (N what def-flag) |
| 17504 | WHAT is \"d\", \"w\", \"m\", or \"y\" for day. week, month, year. | 17504 | WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year. |
| 17505 | N is the number if WHATs to shift | 17505 | N is the number of WHATs to shift. |
| 17506 | DEF-FLAG is t when a double ++ or -- indicates shift relative to | 17506 | DEF-FLAG is t when a double ++ or -- indicates shift relative to |
| 17507 | the DEFAULT date rather than TODAY." | 17507 | the DEFAULT date rather than TODAY." |
| 17508 | (when (string-match | 17508 | (when (string-match |
| @@ -19471,7 +19471,7 @@ L Timeline for current buffer # List stuck projects (!=configure) | |||
| 19471 | ((and (> (length selstring) 0) (eq c ?\d)) | 19471 | ((and (> (length selstring) 0) (eq c ?\d)) |
| 19472 | (delete-window) | 19472 | (delete-window) |
| 19473 | (org-agenda-get-restriction-and-command prefix-descriptions)) | 19473 | (org-agenda-get-restriction-and-command prefix-descriptions)) |
| 19474 | 19474 | ||
| 19475 | ((equal c ?q) (error "Abort")) | 19475 | ((equal c ?q) (error "Abort")) |
| 19476 | (t (error "Invalid key %c" c)))))))) | 19476 | (t (error "Invalid key %c" c)))))))) |
| 19477 | 19477 | ||
| @@ -19518,7 +19518,7 @@ L Timeline for current buffer # List stuck projects (!=configure) | |||
| 19518 | "Run an agenda command in batch mode and send the result to STDOUT. | 19518 | "Run an agenda command in batch mode and send the result to STDOUT. |
| 19519 | If CMD-KEY is a string of length 1, it is used as a key in | 19519 | If CMD-KEY is a string of length 1, it is used as a key in |
| 19520 | `org-agenda-custom-commands' and triggers this command. If it is a | 19520 | `org-agenda-custom-commands' and triggers this command. If it is a |
| 19521 | longer string is is used as a tags/todo match string. | 19521 | longer string it is used as a tags/todo match string. |
| 19522 | Paramters are alternating variable names and values that will be bound | 19522 | Paramters are alternating variable names and values that will be bound |
| 19523 | before running the agenda command." | 19523 | before running the agenda command." |
| 19524 | (let (pars) | 19524 | (let (pars) |
| @@ -19543,7 +19543,7 @@ before running the agenda command." | |||
| 19543 | "Run an agenda command in batch mode and send the result to STDOUT. | 19543 | "Run an agenda command in batch mode and send the result to STDOUT. |
| 19544 | If CMD-KEY is a string of length 1, it is used as a key in | 19544 | If CMD-KEY is a string of length 1, it is used as a key in |
| 19545 | `org-agenda-custom-commands' and triggers this command. If it is a | 19545 | `org-agenda-custom-commands' and triggers this command. If it is a |
| 19546 | longer string is is used as a tags/todo match string. | 19546 | longer string it is used as a tags/todo match string. |
| 19547 | Paramters are alternating variable names and values that will be bound | 19547 | Paramters are alternating variable names and values that will be bound |
| 19548 | before running the agenda command. | 19548 | before running the agenda command. |
| 19549 | 19549 | ||
| @@ -19600,7 +19600,7 @@ agenda-day The day in the agenda where this is listed" | |||
| 19600 | 19600 | ||
| 19601 | (defun org-fix-agenda-info (props) | 19601 | (defun org-fix-agenda-info (props) |
| 19602 | "Make sure all properties on an agenda item have a canonical form, | 19602 | "Make sure all properties on an agenda item have a canonical form, |
| 19603 | so the the export commands caneasily use it." | 19603 | so the export commands can easily use it." |
| 19604 | (let (tmp re) | 19604 | (let (tmp re) |
| 19605 | (when (setq tmp (plist-get props 'tags)) | 19605 | (when (setq tmp (plist-get props 'tags)) |
| 19606 | (setq props (plist-put props 'tags (mapconcat 'identity tmp ":")))) | 19606 | (setq props (plist-put props 'tags (mapconcat 'identity tmp ":")))) |
| @@ -26695,7 +26695,7 @@ Also updates the keyword regular expressions." | |||
| 26695 | (message "Org-mode restarted to refresh keyword and special line setup")) | 26695 | (message "Org-mode restarted to refresh keyword and special line setup")) |
| 26696 | 26696 | ||
| 26697 | (defun org-kill-note-or-show-branches () | 26697 | (defun org-kill-note-or-show-branches () |
| 26698 | "If this is a Note buffer, abort storing the note. Else call `show-branches'." | 26698 | "If this is a Note buffer, abort storing the note. Else call `show-branches'." |
| 26699 | (interactive) | 26699 | (interactive) |
| 26700 | (if (not org-finish-function) | 26700 | (if (not org-finish-function) |
| 26701 | (call-interactively 'show-branches) | 26701 | (call-interactively 'show-branches) |