emacs: lisp/textmodes/org.el comparison

comparison lisp/textmodes/org.el @ 63902:0b526dc24ccb

(org-agenda-start-on-weekday, org-calendar-to-agenda-key, org-agenda-sorting-strategy, org-agenda-use-time-grid, org-archive-location, org-allow-space-in-links, org-usenet-links-prefer-google, org-enable-table-editor, org-export-default-language, org-export-html-show-new-buffer, org-fill-paragraph, org-cycle, org-goto-ret, org-goto-left, org-goto-right, org-goto-quit, org-occur, org-eval-in-calendar, org-agenda-cleanup-fancy-diary, org-agenda-no-heading-message, org-agenda-diary-entry, org-remember-help, org-table-convert-region, org-at-table-p, org-table-move-row-down, org-table-move-row-up, org-table-copy-region, org-table-toggle-vline-visibility, org-table-get-stored-formulas, org-table-get-specials, org-recalc-commands, org-table-eval-formula, org-table-formula-substitute-names, orgtbl-make-binding, org-format-org-table-html, org-format-table-table-html, org-format-table-table-html-using-table-generate-source, org-customize): Fix typos in docstrings. (org-level-2, org-at-timestamp-p, org-agenda-day-view, org-agenda-toggle-diary, org-agenda-toggle-time-grid, org-back-to-heading): Doc fixes. (org-agenda-toggle-time-grid, org-cmp-category, org-cmp-time, org-agenda-change-all-lines, org-get-header): Improve argument/docstring consistency. (orgtbl-error): Fix error message.

author	Juanma Barranquero <lekktu@gmail.com>
date	Fri, 01 Jul 2005 14:38:23 +0000
parents	d367f23e6db1
children	dc2198941327

comparison

equal deleted inserted replaced

-:05e4043d377b
+:0b526dc24ccb
 ;; org.el --- Outline-based notes management and organizer
 ;; Carstens outline-mode for keeping track of everything.
 ;; Copyright (c) 2004, 2005 Free Software Foundation
 ;;
 ;; Author: Carsten Dominik <dominik at science dot uva dot nl>
 ;; Keywords: outlines, hypermedia, calendar
 (save-restriction
 (widen)
 (goto-char (point-min))
 (while (re-search-forward re nil t)
 (setq key (match-string 1) value (match-string 2))
 (cond
 ((equal key "CATEGORY")
 (if (string-match "[ \t]+$" value)
 (setq value (replace-match "" t t value)))
 (setq cat (intern value)))
 ((equal key "SEQ_TODO")
 ;; Compute the regular expressions and other local variables
 (setq org-todo-kwd-priority-p (equal org-todo-interpretation 'priority)
 org-todo-kwd-max-priority (1- (length org-todo-keywords))
 org-ds-keyword-length (+ 2 (max (length org-deadline-string)
 (length org-scheduled-string)))
 org-done-string
 (nth (1- (length org-todo-keywords)) org-todo-keywords)
 org-todo-regexp
 (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords
 "\\|") "\\)\\>")
 org-not-done-regexp
 :group 'org-agenda
 :type 'boolean)
 (defcustom org-select-agenda-window t
 "Non-nil means, after creating an agenda, move cursor into Agenda window.
 When nil, cursor will remain in the current window."
 :group 'org-agenda
 :type 'boolean)
 (defcustom org-fit-agenda-window t
 "Non-nil means, change window size of agenda to fit content."
 ;; FIXME: First day of month works only for current month because it would
 ;; require a variable ndays treatment.
 (defcustom org-agenda-start-on-weekday 1
 "Non-nil means, start the overview always on the specified weekday.
-0 Denotes Sunday, 1 denotes Monday etc.
+0 denotes Sunday, 1 denotes Monday etc.
 When nil, always start on the current day."
 :group 'org-agenda
 :type '(choice (const :tag "Today" nil)
 (const :tag "First day of month" t)
 (number :tag "Weekday No.")))
 (defcustom org-agenda-include-all-todo t
 "Non-nil means, the agenda will always contain all TODO entries.
 When nil, date-less entries will only be shown if `org-agenda' is called
 with a prefix argument.
 When non-nil, the TODO entries will be listed at the top of the agenda, before
 the entries for specific days."
 :group 'org-agenda
 :type 'boolean)
 (defcustom org-agenda-include-diary nil
 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
 :type 'boolean)
 (defcustom org-calendar-to-agenda-key [?c]
 "The key to be installed in `calendar-mode-map' for switching to the agenda.
 The command `org-calendar-goto-agenda' will be bound to this key.  The
-default is the character `c' because then`c' can be used to switch back and
+default is the character `c' because then `c' can be used to switch back and
-force between agenda and calendar."
+forth between agenda and calendar."
 :group 'org-agenda
 :type 'sexp)
 (defcustom org-agenda-sorting-strategy '(time-up category-keep priority-down)
 "Sorting structure for the agenda items of a single day.
 This is a list of symbols which will be used in sequence to determine
 if an entry should be listed before another entry.  The following
-symbols are recognized.
+symbols are recognized:
 time-up         Put entries with time-of-day indications first, early first
 time-down       Put entries with time-of-day indications first, late first
 category-keep   Keep the default order of categories, corresponding to the
 sequence in `org-agenda-files'.
 priority.
 Leaving out `category-keep' would mean that items will be sorted across
 categories by priority."
 :group 'org-agenda
 :type '(repeat
 (choice
 (const time-up)
 (const time-down)
 (const category-keep)
 (const category-up)
 of `org-agenda-prefix-format' or `org-timeline-prefix-format'.")
 (defcustom org-agenda-use-time-grid t
 "Non-nil means, show a time grid in the agenda schedule.
 A time grid is a set of lines for specific times (like every two hours between
-8:00 and 20:00.  The items scheduled for a day at specific times are
+8:00 and 20:00).  The items scheduled for a day at specific times are
 sorted in between these lines.
-For deails about when the grid will be shown, and what it will look like, see
+For details about when the grid will be shown, and what it will look like, see
 the variable `org-agenda-time-grid'."
 :group 'org-agenda
 :type 'boolean)
 (defcustom org-agenda-time-grid
 '((daily today require-timed)
 "----------------"
 (800 1000 1200 1400 1600 1800 2000))
 "The settings for time grid for agenda display.
 The second item is a string which will be places behing the grid time.
 The third item is a list of integers, indicating the times that should have
 a grid line."
 :group 'org-agenda
 :type
 '(list
 (set :greedy t :tag "Grid Display Options"
 (const :tag "Show grid in single day agenda display" daily)
 (const :tag "Show grid in weekly agenda display" weekly)
 (const :tag "Always show grid for today" today)
 :group 'org-structure
 :type 'boolean)
 (defcustom org-archive-location "%s_archive::"
 "The location where subtrees should be archived.
 This string consists of two parts, separated by a double-colon.
 The first part is a file name - when omitted, archiving happens in the same
-file.  %s will be replaced by the current file name (without directory part).
+file.  `%s' will be replaced by the current file name (without directory part).
 Archiving to a different file is useful to keep archived entries from
 contributing to the Org-mode Agenda.
 The part after the double colon is a headline.  The archived entries will be
 filed under that headline.  When omitted, the subtrees are simply filed away
 Archive in file ./basement (relative path), as level 3 trees
 below the level 2 heading \"** Finished Tasks\".
 You may set this option on a per-file basis by adding to the buffer a
 line like
 #+ARCHIVE: basement::** Finished Tasks"
 :group 'org-structure
 :type 'string)
 (defcustom org-archive-mark-done t
 (defcustom org-allow-space-in-links t
 "Non-nil means, file names in links may contain space characters.
 When nil, it becomes possible to put several links into a line.
 Note that in tables, a link never extends accross fields, so in a table
 it is always possible to put several links into a line.
-Changing this varable requires a re-launch of Emacs of become effective."
+Changing this variable requires a re-launch of Emacs to become effective."
 :group 'org-link
 :type 'boolean)
 (defcustom org-line-numbers-in-file-links t
 "Non-nil means, file links from `org-store-link' contain line numbers.
 (const find-file)
 (const find-file-other-window)
 (const find-file-other-frame)))))
 (defcustom org-usenet-links-prefer-google nil
-"Non-nil means, `org-store-link' will create web links to google groups.
+"Non-nil means, `org-store-link' will create web links to Google groups.
 When nil, Gnus will be used for such links.
 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
 negates this setting for the duration of the command."
 :group 'org-link
 :type 'boolean)
 (defcustom org-enable-table-editor 'optimized
 "Non-nil means, lines starting with \"|\" are handled by the table editor.
 When nil, such lines will be treated like ordinary lines.
 When equal to the symbol `optimized', the table editor will be optimized to
-do the following
+do the following:
 - Use automatic overwrite mode in front of whitespace in table fields.
-This make the structure of the table stay in tact as long as the edited
+This makes the structure of the table stay intact as long as the edited
 field does not exceed the column width.
 - Minimize the number of realigns.  Normally, the table is aligned each time
 TAB or RET are pressed to move to another field.  With optimization this
-happens only if changes to a field might have  changed the column width.
+happens only if changes to a field might have changed the column width.
 Optimization requires replacing the functions `self-insert-command',
 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
 slight (in fact: unnoticeable) speed impact for normal typing.  Org-mode is
 very good at guessing when a re-align will be necessary, but you can always
 force one with `C-c C-c'.
 (string :tag "Date")
 (string :tag "Table of Contents"))))
 (defcustom org-export-default-language "en"
 "The default language of HTML export, as a string.
-This should have an association in `org-export-language-setup'"
+This should have an association in `org-export-language-setup'."
 :group 'org-export
 :type 'string)
 (defcustom org-export-headline-levels 3
 "The last level which is still exported as a headline.
 Otherwise the buffer will just be saved to a file and stay hidden."
 :group 'org-export
 :type 'boolean)
 (defcustom org-export-html-show-new-buffer nil
-"Non-nil means,  popup buffer containing the exported html text.
+"Non-nil means, popup buffer containing the exported HTML text.
 Otherwise, the buffer will just be saved to a file and stay hidden."
 :group 'org-export
 :type 'boolean)
 (defgroup org-faces nil
 (((class color) (background dark)) (:foreground "chocolate1"))
 (t (:bold t :italic t)))
 "Face for items scheduled previously, and not yet done."
 :group 'org-faces)
 (defface org-link
 '((((type tty) (class color)) (:foreground "cyan" :weight bold))
 (((class color) (background light)) (:foreground "Purple"))
 (((class color) (background dark)) (:foreground "Cyan"))
 (t (:bold t)))
 "Face for links."
 (defface org-time-grid ;; font-lock-variable-name-face
 '((((type tty) (class color)) (:foreground "yellow" :weight light))
 (((class color) (background light)) (:foreground "DarkGoldenrod"))
 (((class color) (background dark)) (:foreground "LightGoldenrod"))
 (t (:bold t :italic t)))
-"Face used for level 2 headlines."
+"Face used for time grids."
 :group 'org-faces)
 (defvar org-level-faces
 '(
 org-level-1
 (defvar org-inhibit-startup nil)        ; Dynamically-scoped param.
 ;;;###autoload
 (define-derived-mode org-mode outline-mode "Org"
 "Outline-based notes management and organizer, alias
 \"Carstens outline-mode for keeping track of everything.\"
 Org-mode develops organizational tasks around a NOTES file which
 contains information about projects as plain text.  Org-mode is
 implemented on top of outline-mode, which is ideal to keep the content
 ((eq org-startup-folded 'content)
 (let ((this-command 'org-cycle) (last-command 'org-cycle))
 (org-cycle '(4)) (org-cycle '(4))))))))
 (defun org-fill-paragraph (&optional justify)
-"Re-align a table, pass through to fill-paragraph if no table."
+"Re-align a table, pass through to `fill-paragraph' if no table."
 (save-excursion
 (beginning-of-line 1)
 (looking-at "\\s-*\\(|\\|\\+-+\\)")))
 (defsubst org-current-line (&optional pos)
 (+ (if (bolp) 1 0) (count-lines (point-min) (or pos (point)))))
 ;;; Font-Lock stuff
 (defvar org-mouse-map (make-sparse-keymap))
 (define-key org-mouse-map
 (if org-xemacs-p [button2] [mouse-2]) 'org-open-at-mouse)
 (define-key org-mouse-map
 (if org-xemacs-p [button3] [mouse-3]) 'org-find-file-at-mouse)
 (require 'font-lock)
 (list (concat "\\[#[A-Z]\\]") '(0 'org-warning t))
 (list (concat "\\<" org-deadline-string) '(0 'org-warning t))
 (list (concat "\\<" org-scheduled-string) '(0 'org-warning t))
 ;; '("\\(\\s-\\|^\\)\\(\\*\\([a-zA-Z]+\\)\\*\\)\\([^a-zA-Z*]\\|$\\)"
 ;; (3 'bold))
 ;; '("\\(\\s-\\|^\\)\\(/\\([a-zA-Z]+\\)/\\)\\([^a-zA-Z*]\\|$\\)"
 ;; (3 'italic))
 ;; '("\\(\\s-\\|^\\)\\(_\\([a-zA-Z]+\\)_\\)\\([^a-zA-Z*]\\|$\\)"
 ;; (3 'underline))
 (list (concat "^\\*+[ \t]*\\<\\(" org-comment-string "\\)\\>")
 '(1 'org-warning t))
 '("^#.*" (0 'font-lock-comment-face t))
 (if org-fontify-done-headline
 (set (make-local-variable 'org-font-lock-keywords)
 (append
 (if org-noutline-p     ; FIXME:  I am not sure if eval will work
 ; on XEmacs if noutline is ever ported
 '((eval . (list "^\\(\\*+\\).*"
 0 '(nth
 (% (- (match-end 1) (match-beginning 1) 1)
 org-n-levels)
 org-level-faces)
 nil t)))
 '(("^\\(\\(\\*+\\)[^\r\n]*\\)[\n\r]"
 nil t))))
 org-font-lock-extra-keywords))
 (set (make-local-variable 'font-lock-defaults)
 '(org-font-lock-keywords t nil nil backward-paragraph))
 (kill-local-variable 'font-lock-keywords) nil))
 (defun org-unfontify-region (beg end &optional maybe_loudly)
 "Remove fontification and activation overlays from links."
 (font-lock-default-unfontify-region beg end)
 (let* ((buffer-undo-list t)
 (inhibit-read-only t) (inhibit-point-motion-hooks t)
 (defvar org-cycle-subtree-status nil)
 (defun org-cycle (&optional arg)
 "Visibility cycling for Org-mode.
 - When this function is called with a prefix argument, rotate the entire
-buffer through 3 states (global cycling)
+buffer through 3 states (global cycling):
 1. OVERVIEW: Show only top-level headlines.
 2. CONTENTS: Show all headlines of all levels, but no body text.
 3. SHOW ALL: Show everything.
 - When point is at the beginning of a headline, rotate the subtree started
-by this line through 3 different states (local cycling)
+by this line through 3 different states (local cycling):
 1. FOLDED:   Only the main headline is shown.
 2. CHILDREN: The main headline and the direct children are shown.  From
 this state, you can move to one of the children and
 zoom in further.
 3. SUBTREE:  Show the entire subtree, including body text.
 (kill-buffer "*org-goto*")
 org-selected-point))
 ;;  FIXME:  It may not be a good idea to temper with the prefix argument...
 (defun org-goto-ret (&optional arg)
-"Finish org-goto by going to the new location."
+"Finish `org-goto' by going to the new location."
 (interactive "P")
 (setq org-selected-point (point)
 current-prefix-arg arg)
 (throw 'exit nil))
 (defun org-goto-left ()
-"Finish org-goto by going to the new location."
+"Finish `org-goto' by going to the new location."
 (interactive)
 (if (org-on-heading-p)
 (progn
 (beginning-of-line 1)
 (setq org-selected-point (point)
 current-prefix-arg (- (match-end 0) (match-beginning 0)))
 (throw 'exit nil))
 (error "Not on a heading")))
 (defun org-goto-right ()
-"Finish org-goto by going to the new location."
+"Finish `org-goto' by going to the new location."
 (interactive)
 (if (org-on-heading-p)
 (progn
 (outline-end-of-subtree)
 (or (eobp) (forward-char 1))
 current-prefix-arg (- (match-end 0) (match-beginning 0)))
 (throw 'exit nil))
 (error "Not on a heading")))
 (defun org-goto-quit ()
-"Finish org-goto without cursor motion."
+"Finish `org-goto' without cursor motion."
 (interactive)
 (setq org-selected-point nil)
 (throw 'exit nil))
 ;;; Promotion, Demotion, Inserting new headlines
 (or (bolp) (insert "\n"))
 (insert "\n" heading "\n")
 (end-of-line 0))
 ;; Make the heading visible, and the following as well
 (let ((org-show-following-heading t)) (org-show-hierarchy-above))
 (if (re-search-forward
 (concat "^" (regexp-quote (make-string level ?*)) "[ \t]")
 nil t)
 (progn (goto-char (match-beginning 0)) (insert "\n")
 (beginning-of-line 0))
 (goto-char (point-max)) (insert "\n")))
 (completion-ignore-case opt)
 (type nil)
 (table (cond
 (opt
 (setq type :opt)
 (mapcar (lambda (x)
 (string-match "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
 (cons (match-string 2 x) (match-string 1 x)))
 (org-split-string (org-get-current-options) "\n")))
 (texp
 (setq type :tex)
 org-html-entities)
 (form
 (setq type :form)
 '(("sum") ("sumv") ("sumh")))
 ((string-match "\\`\\*+[ \t]*\\'"
 (buffer-substring (point-at-bol) beg))
 (setq type :todo)
 (mapcar 'list org-todo-keywords))
 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
 (completion (try-completion pattern table)))
 (cond ((eq completion t)
 (if (equal type :opt)
 (insert (substring (cdr (assoc (upcase pattern) table))
 (length pattern)))))
 ((null completion)
 (message "Can't find completion for \"%s\"" pattern)
 (ding))
 ((not (string= pattern completion))
 (delete-region beg end)
 (if (string-match " +$" completion)
 (setq completion (replace-match "" t t completion)))
 (insert completion)
 (if (get-buffer-window "*Completions*")
 (delete-window (get-buffer-window "*Completions*")))
 (if (and (eq type :todo)
 (defun org-occur (regexp &optional callback)
 "Make a compact tree which shows all matches of REGEXP.
 The tree will show the lines where the regexp matches, and all higher
 headlines above the match.  It will also show the heading after the match,
 to make sure editing the matching entry is easy.
-if CALLBACK is non-nil, it is a function which is called to confirm
+If CALLBACK is non-nil, it is a function which is called to confirm
 that the match should indeed be shown."
 (interactive "sRegexp: ")
 (setq regexp (org-check-occur-regexp regexp))
 (let ((cnt 0))
 (save-excursion
 (defun org-get-priority (s)
 "Find priority cookie and return priority."
 (save-match-data
 (if (not (string-match org-priority-regexp s))
 (* 1000 (- org-lowest-priority org-default-priority))
 (* 1000 (- org-lowest-priority
 (string-to-char (match-string 2 s)))))))
 ;;; Timestamps
 (defvar org-last-changed-timestamp nil)
 (defun org-time-stamp (arg)
 (insert (format-time-string fmt time)))
 ((org-at-timestamp-p)
 (setq time (let ((this-command this-command))
 (org-read-date arg 'totime)))
 (and (org-at-timestamp-p) (replace-match
 (setq org-last-changed-timestamp
 (format-time-string fmt time))
 t t))
 (message "Timestamp updated"))
 (t
 (setq time (let ((this-command this-command))
 but this can be configured with the variables `parse-time-months' and
 `parse-time-weekdays'.
 While prompting, a calendar is popped up - you can also select the
 date with the mouse (button 1).  The calendar shows a period of three
 month.  To scroll it to other months, use the keys `>' and `<'.
 If you don't like the calendar, turn it off with
 \(setq org-popup-calendar-for-date-prompt nil).
 With optional argument TO-TIME, the date will immediately be converted
 to an internal time.
 With an optional argument WITH-TIME, the prompt will suggest to also
 used to insert the time stamp into the buffer to include the time."
 (let* ((default-time
 ;; Default time is either today, or, when entering a range,
 ;; the range start.
 (if (save-excursion
 (re-search-backward
 (concat org-ts-regexp "--\\=")
 (- (point) 20) t))
 (apply
 'encode-time
 (mapcar (lambda(x) (or x 0))  ;; FIXME: Problem with timezone?
 (format "%04d-%02d-%02d %02d:%02d" year month day hour minute)
 (format "%04d-%02d-%02d" year month day)))))
 (defun org-eval-in-calendar (form)
 "Eval FORM in the calendar window and return to current window.
-Also, store the cursor date in variable ans2."
+Also, store the cursor date in variable `ans2'."
 (let ((sw (selected-window)))
 (select-window (get-buffer-window "*Calendar*"))
 (eval form)
 (when (calendar-cursor-to-date)
 (let* ((date (calendar-cursor-to-date))
 (when (calendar-cursor-to-date)
 (let* ((date (calendar-cursor-to-date))
 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
 (setq ans1 (format-time-string "%Y-%m-%d" time)))
 (if (active-minibuffer-window) (exit-minibuffer))))
 (defun org-check-deadlines (ndays)
 "Check if there are any deadlines due or past due.
 A deadline is considered due if it happens within `org-deadline-warning-days'
 days from today's date.  If the deadline appears in an entry marked DONE,
 it is not shown.  The prefix arg NDAYS can be used to test that many
 (and (match-beginning n)
 (<= (match-beginning n) pos)
 (>= (match-end n) pos)))
 (defun org-at-timestamp-p ()
-"Determine if the cursor is  or at a timestamp."
+"Determine if the cursor is at a timestamp."
 (interactive)
 (let* ((tsr org-ts-regexp2)
 (pos (point))
 (ans (or (looking-at tsr)
 (save-excursion
 (easy-menu-add org-agenda-menu)
 (if org-startup-truncated (setq truncate-lines t))
 (add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
 (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
 (setq org-agenda-follow-mode nil)
 (easy-menu-change
 '("Agenda") "Agenda Files"
 (append
 (list
 ["Edit File List" (customize-variable 'org-agenda-files) t]
 "--")
 (mapcar 'org-file-menu-entry org-agenda-files)))
 (org-agenda-set-mode-name)
 (apply
 (define-key org-agenda-mode-map [(left)] 'org-agenda-earlier)
 (defvar org-agenda-keymap (copy-keymap org-agenda-mode-map)
 "Local keymap for agenda entries from Org-mode.")
 (define-key org-agenda-keymap
 (if org-xemacs-p [(button2)] [(mouse-2)]) 'org-agenda-goto-mouse)
 (define-key org-agenda-keymap
 (if org-xemacs-p [(button3)] [(mouse-3)]) 'org-agenda-show-mouse)
 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
 ("Agenda Files")
 "--"
 ["Show" org-agenda-show t]
 ["Go To (other window)" org-agenda-goto t]
 ["Go To (one window)" org-agenda-switch-to t]
 ["Follow Mode" org-agenda-follow-mode
 :style toggle :selected org-agenda-follow-mode :active t]
 "--"
 ["Cycle TODO" org-agenda-todo t]
 ("Reschedule"
 ["Reschedule +1 day" org-agenda-date-later t]
 t)) ; always include today
 (today (time-to-days (current-time)))
 (org-respect-restriction t)
 (past t)
 s e rtn d)
 (setq org-agenda-redo-command
 (list 'progn
 (list 'switch-to-buffer-other-window (current-buffer))
 (list 'org-timeline include-all)))
 (if (not dopast)
 ;; Remove past dates from the list of dates.
 (setq day-numbers (delq nil (mapcar (lambda(x)
 (if (>= x today) x nil))
 day-numbers))))
 (switch-to-buffer-other-window
 (get-buffer-create org-agenda-buffer-name))
 (setq buffer-read-only nil)
 (erase-buffer)
 (org-agenda-mode) (setq buffer-read-only nil)
 (while (setq d (pop day-numbers))
 (setq past nil)
 (insert (make-string 79 ?-) "\n")))
 (setq date (calendar-gregorian-from-absolute d))
 (setq s (point))
 (if dotodo
 (setq rtn (org-agenda-get-day-entries
 entry date :todo :timestamp))
 (setq rtn (org-agenda-get-day-entries entry date :timestamp)))
 (if (or rtn (equal d today))
 (progn
 (insert (calendar-day-name date) " "
 (d (- nt n1)))
 (- sd (+ (if (< d 0) 7 0) d)))))
 (day-numbers (list start))
 (inhibit-redisplay t)
 s e rtn rtnall file date d start-pos end-pos todayp nd)
 (setq org-agenda-redo-command
 (list 'org-agenda include-all start-day ndays))
 ;; Make the list of days
 (setq ndays (or ndays org-agenda-ndays)
 nd ndays)
 (while (> ndays 1)
 (setq ndays (1- ndays)))
 (setq day-numbers (nreverse day-numbers))
 (if (not (equal (current-buffer) (get-buffer org-agenda-buffer-name)))
 (progn
 (delete-other-windows)
 (switch-to-buffer-other-window
 (get-buffer-create org-agenda-buffer-name))))
 (setq buffer-read-only nil)
 (erase-buffer)
 (org-agenda-mode) (setq buffer-read-only nil)
 (set (make-local-variable 'starting-day) (car day-numbers))
 (org-check-agenda-file file)
 (setq date (calendar-gregorian-from-absolute today)
 rtn (org-agenda-get-day-entries
 file date :todo))
 (setq rtnall (append rtnall rtn))))
 (when rtnall
 (insert "ALL CURRENTLY OPEN TODO ITEMS:\n")
 (add-text-properties (point-min) (1- (point))
 (list 'face 'org-link))
 (insert (org-finalize-agenda-entries rtnall) "\n")))
 (while (setq d (pop day-numbers))
 (extract-calendar-day date)
 (calendar-month-name (extract-calendar-month date))
 (extract-calendar-year date)))
 (put-text-property s (1- (point)) 'face
 'org-link)
 (if rtnall (insert
 (org-finalize-agenda-entries ;; FIXME: condition needed
 (org-agenda-add-time-grid-maybe
 rtnall nd todayp))
 "\n"))
 (put-text-property s (1- (point)) 'day d))))
 (goto-char (point-min))
 (setq buffer-read-only t)
 (if org-fit-agenda-window
 (fit-window-to-buffer nil (/ (* (frame-height) 3) 4)
 (/ (frame-height) 2)))
 "Switch to weekly view for agenda."
 (interactive)
 (unless (boundp 'starting-day)
 (error "Not allowed"))
 (setq org-agenda-ndays 7)
 (org-agenda include-all-loc
 (or (get-text-property (point) 'day)
 starting-day))
 (org-agenda-set-mode-name)
 (message "Switched to week view"))
 (defun org-agenda-day-view ()
-"Switch to weekly view for agenda."
+"Switch to daily view for agenda."
 (interactive)
 (unless (boundp 'starting-day)
 (error "Not allowed"))
 (setq org-agenda-ndays 1)
 (org-agenda include-all-loc
 (or (get-text-property (point) 'day)
 starting-day))
 (org-agenda-set-mode-name)
 (message "Switched to day view"))
 (org-agenda-set-mode-name)
 (message "Follow mode is %s"
 (if org-agenda-follow-mode "on" "off")))
 (defun org-agenda-toggle-diary ()
-"Toggle follow mode in an agenda buffer."
+"Toggle diary inclusion in an agenda buffer."
 (interactive)
 (setq org-agenda-include-diary (not org-agenda-include-diary))
 (org-agenda-redo)
 (org-agenda-set-mode-name)
 (message "Diary inclusion turned %s"
 (if org-agenda-include-diary "on" "off")))
 (defun org-agenda-toggle-time-grid ()
-"Toggle follow mode in an agenda buffer."
+"Toggle time-grid in an agenda buffer."
 (interactive)
 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
 (org-agenda-redo)
 (org-agenda-set-mode-name)
 (message "Time-grid turned %s"
 (defun org-get-entries-from-diary (date)
 "Get the (Emacs Calendar) diary entries for DATE."
 (let* ((fancy-diary-buffer "*temporary-fancy-diary-buffer*")
 (diary-display-hook '(fancy-diary-display))
 (list-diary-entries-hook
 (cons 'org-diary-default-entry list-diary-entries-hook))
 entries
 (org-disable-diary t))
 (save-excursion
 (save-window-excursion
 (setq entries (buffer-substring (point-min) (- (point-max) 1)))))
 (set-buffer-modified-p nil)
 (kill-buffer fancy-diary-buffer)))
 (when entries
 (setq entries (org-split-string entries "\n"))
 (setq entries
 (mapcar
 (lambda (x)
 (setq x (org-format-agenda-item "" x "Diary" 'time))
 ;; Extend the text properties to the beginning of the line
 (add-text-properties
 0 (length x)
 (text-properties-at (1- (length x)) x)
 x)
 x)
 entries)))))
 (defun org-agenda-cleanup-fancy-diary ()
-"Remove unwanted stuff in buffer created by fancy-diary-display.
+"Remove unwanted stuff in buffer created by `fancy-diary-display'.
 This gets rid of the date, the underline under the date, and
 the dummy entry installed by `org-mode' to ensure non-empty diary for each
-date.  Itt also removes lines that contain only whitespace."
+date.  It also removes lines that contain only whitespace."
 (goto-char (point-min))
 (if (looking-at ".*?:[ \t]*")
 (progn
 (replace-match "")
 (re-search-forward "\n=+$" nil t)
 (buffer-file-name))
 (add-text-properties
 0 (length string)
 (list 'mouse-face 'highlight
 'keymap org-agenda-keymap
 'help-echo
 (format
 "mouse-2 or RET jump to diary file %s"
 (abbreviate-file-name (buffer-file-name)))
 'org-agenda-diary-link t
 'org-marker (org-agenda-new-marker (point-at-bol)))
 (defun org-add-file (&optional file)
 "Add current file to the list of files in variable `org-agenda-files'.
 These are the files which are being checked for agenda entries.
 Optional argument FILE means, use this file instead of the current.
 It is possible (but not recommended) to add this function to the
 `org-mode-hook'."
 (interactive)
 (catch 'exit
 (let* ((file (or file (buffer-file-name)
 (if (interactive-p)
 (error "Buffer is not visiting a file")
 (lambda (x)
 (equal true-file (file-truename x)))
 org-agenda-files))))
 (if (not present)
 (progn
 (setq org-agenda-files
 (cons afile org-agenda-files))
 ;; Make sure custom.el does not end up with Org-mode
 (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
 (customize-save-variable 'org-agenda-files org-agenda-files))
 (org-install-agenda-files-menu)
 Optional argument FILE means, use this file instead of the current."
 (interactive)
 (let* ((file (or file (buffer-file-name)))
 (true-file (file-truename file))
 (afile (abbreviate-file-name file))
 (files (delq nil (mapcar
 (lambda (x)
 (if (equal true-file
 (file-truename x))
 nil x))
 org-agenda-files))))
 ;;;###autoload
 (defun org-diary (&rest args)
 "Return diary information from org-files.
 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
 It accesses org files and extracts information from those files to be
 listed in the diary.  The function accepts arguments specifying what
 items should be listed.  The following arguments are allowed:
 :timestamp    List the headlines of items containing a date stamp or
 date range matching the selected date.  Deadlines will
 &%%(org-diary :deadline :timestamp :scheduled)
 The function expects the lisp variables `entry' and `date' to be provided
 by the caller, because this is how the calendar works.  Don't use this
 function from a program - use `org-agenda-get-day-entries' instead."
 (org-agenda-maybe-reset-markers)
 (org-compile-prefix-format org-agenda-prefix-format)
 (setq args (or args '(:deadline :scheduled :timestamp)))
 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
 (list entry)
 (save-restriction
 (if org-respect-restriction
 (if (org-region-active-p)
 ;; Respect a region to restrict search
 (narrow-to-region (region-beginning) (region-end)))
 ;; If we work for the calendar or many files,
 ;; get rid of any restriction
 (widen))
 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
 (while (setq arg (pop args))
 (cond
 (goto-char (point-min))
 (while (re-search-forward regexp nil t)
 (goto-char (match-beginning 1))
 (setq marker (org-agenda-new-marker (point-at-bol))
 txt (org-format-agenda-item "" (match-string 1))
 priority
 (+ (org-get-priority txt)
 (if org-todo-kwd-priority-p
 (- org-todo-kwd-max-priority -2
 (length
 (member (match-string 2) org-todo-keywords)))
 (push txt ee)
 (goto-char (match-end 1)))
 (nreverse ee)))
 (defconst org-agenda-no-heading-message
-"No heading for this item in buffer or region")
+"No heading for this item in buffer or region.")
 (defun org-agenda-get-timestamps ()
 "Return the date stamp information for agenda display."
 (let* ((props (list 'face nil
 'mouse-face 'highlight
 'org-hd-marker hdmarker) props)
 txt)
 (if deadlinep
 (add-text-properties
 0 (length txt)
 (list 'face
 (if donep 'org-done 'org-warning)
 'undone-face 'org-warning
 'done-face 'org-done
 'priority (+ 100 priority))
 txt)
 (setq txt (org-format-agenda-item
 (format "In %3d d.: " diff) head))))
 (setq txt org-agenda-no-heading-message))
 (when txt
 (add-text-properties
 0 (length txt)
 (append
 (list 'org-marker (org-agenda-new-marker pos)
 'org-hd-marker (org-agenda-new-marker pos1)
 'priority (+ (- 10 diff) (org-get-priority txt))
 'face (cond ((<= diff 0) 'org-warning)
 ((<= diff 5) 'org-scheduled-previously)
 (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
 (progn
 (setq hdmarker (org-agenda-new-marker (match-end 1)))
 (goto-char (match-end 1))
 (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
 (setq txt (org-format-agenda-item
 (format (if (= d1 d2) "" "(%d/%d): ")
 (1+ (- d0 d1)) (1+ (- d2 d1)))
 (match-string 1) nil (if (= d0 d1) timestr))))
 (setq txt org-agenda-no-heading-message))
 (add-text-properties
 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
 (setq plain (string-match org-plain-time-of-day-regexp ts)))
 (setq s0 (match-string 0 ts)
 s1 (match-string (if plain 1 2) ts)
 s2 (match-string (if plain 8 4) ts))
 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
 ;; them, we might want to remove them there to avoid duplication.
 ;; The user can turn this off with a variable.
 (if (and org-agenda-remove-times-when-in-prefix (or stamp plain)
 (string-match (concat (regexp-quote s0) " *") txt)
 t))
 (setq txt (replace-match "" nil nil txt))))
 ;; Normalize the time(s) to 24 hour
 (if s1 (setq s1 (org-get-time-of-day s1 'string)))
 (if s2 (setq s2 (org-get-time-of-day s2 'string))))
 ;; Create the final string
 (if noprefix
 (setq rtn txt)
 ;; Prepare the variables needed in the eval of the compiled format
 (setq time (cond (s2 (concat s1 "-" s2))
 (t ""))
 extra (or extra "")
 category (if (symbolp category) (symbol-name category) category))
 ;; Evaluate the compiled format
 (setq rtn (concat (eval org-prefix-format-compiled) txt)))
 ;; And finally add the text properties
 (add-text-properties
 0 (length rtn) (list 'category (downcase category)
 'prefix-length (- (length rtn) (length txt))
 'time-of-day time-of-day
 ;; don't show empty grid
 (throw 'exit list))
 (while (setq time (pop gridtimes))
 (unless (and remove (member time have))
 (setq time (int-to-string time))
 (push (org-format-agenda-item
 nil string "" ;; FIXME: put a category?
 (concat (substring time 0 -2) ":" (substring time -2)))
 new)
 (put-text-property
 1 (length (car new)) 'face 'org-time-grid (car new))))
 (if (member 'time-up org-agenda-sorting-strategy)
 (append new list)
 (append list new)))))
 If found, return it as a military time number between 0 and 2400.
 If not found, return nil.
 The optional STRING argument forces conversion into a 5 character wide string
 HH:MM."
 (save-match-data
 (when
 (or
 (string-match
 "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
 (string-match
 "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
 (defun org-finalize-agenda-entries (list)
 "Sort and concatenate the agenda items."
 (mapconcat 'identity (sort list 'org-entries-lessp) "\n"))
 (defsubst org-cmp-priority (a b)
-"Compare the priorities of string a and b."
+"Compare the priorities of strings A and B."
 (let ((pa (or (get-text-property 1 'priority a) 0))
 (pb (or (get-text-property 1 'priority b) 0)))
 (cond ((> pa pb) +1)
 ((< pa pb) -1)
 (t nil))))
 (defsubst org-cmp-category (a b)
-"Compare the string values of categories of strings a and b."
+"Compare the string values of categories of strings A and B."
 (let ((ca (or (get-text-property 1 'category a) ""))
 (cb (or (get-text-property 1 'category b) "")))
 (cond ((string-lessp ca cb) -1)
 ((string-lessp cb ca) +1)
 (t nil))))
 (defsubst org-cmp-time (a b)
-"Compare the time-of-day values of strings a and b."
+"Compare the time-of-day values of strings A and B."
 (let* ((def (if org-sort-agenda-notime-is-late 2401 -1))
 (ta (or (get-text-property 1 'time-of-day a) def))
 (tb (or (get-text-property 1 'time-of-day b) def)))
 (cond ((< ta tb) -1)
 ((< tb ta) +1)
 (priority-up (org-cmp-priority a b))
 (priority-down (if priority-up (- priority-up) nil))
 (category-up (org-cmp-category a b))
 (category-down (if category-up (- category-up) nil))
 (category-keep (if category-up +1 nil)))  ; FIXME +1 or -1?
 (cdr (assoc
 (eval (cons 'or org-agenda-sorting-strategy))
 '((-1 . t) (1 . nil) (nil . nil))))))
 (defun org-agenda-show-priority ()
 "Show the priority of the current item.
 (message "Priority is %d" (if pri pri -1000))))
 (defun org-agenda-goto (&optional highlight)
 "Go to the Org-mode file which contains the item at point."
 (interactive)
 (let* ((marker (or (get-text-property (point) 'org-marker)
 (org-agenda-error)))
 (buffer (marker-buffer marker))
 (pos (marker-position marker)))
 (switch-to-buffer-other-window buffer)
 (widen)
 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
 (defun org-agenda-switch-to ()
 "Go to the Org-mode file which contains the item at point."
 (interactive)
 (let* ((marker (or (get-text-property (point) 'org-marker)
 (org-agenda-error)))
 (buffer (marker-buffer marker))
 (pos (marker-position marker)))
 (switch-to-buffer buffer)
 (delete-other-windows)
 (save-excursion
 (org-agenda-change-all-lines newhead hdmarker 'fixface))
 (move-to-column col)))
 (defun org-agenda-change-all-lines (newhead hdmarker &optional fixface)
-"Change all lines in the agenda buffer which match hdmarker.
+"Change all lines in the agenda buffer which match HDMARKER.
 The new content of the line will be NEWHEAD (as modified by
 `org-format-agenda-item').  HDMARKER is checked with
 `equal' against all `org-hd-marker' text properties in the file.
 If FIXFACE is non-nil, the face of each item is modified acording to
 the new TODO state."
 (progn
 (replace-match new t t)
 (beginning-of-line 1)
 (add-text-properties (point-at-bol) (point-at-eol) props)
 (if fixface
 (add-text-properties
 (point-at-bol) (point-at-eol)
 (list 'face
 (if org-last-todo-state-is-todo
 undone-face done-face))))
 (beginning-of-line 1))
 (match-string 1)
 "")))
 (defun org-agenda-diary-entry ()
 "Make a diary entry, like the `i' command from the calendar.
-All the standard commands work: block, weekly etc"
+All the standard commands work: block, weekly etc."
 (interactive)
 (require 'diary-lib)
 (let* ((char (progn
 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
 (read-char-exclusive)))
 (cmd (cdr (assoc char
 '((?d . insert-diary-entry)
 (?w . insert-weekly-diary-entry)
 (get-text-property point 'day))))))
 (unwind-protect
 (progn
 (fset 'calendar-cursor-to-date
 (lambda (&optional error)
 (calendar-gregorian-from-absolute
 (get-text-property point 'day))))
 (call-interactively cmd))
 (fset 'calendar-cursor-to-date oldf)))))
 (displayed-year (extract-calendar-year date)))
 (unwind-protect
 (progn
 (fset 'calendar-cursor-to-date
 (lambda (&optional error)
 (calendar-gregorian-from-absolute
 (get-text-property point 'day))))
 (call-interactively cmd))
 (fset 'calendar-cursor-to-date oldf))))
 (defun org-agenda-phases-of-moon ()
 (let ((day (get-text-property (point) 'day))
 date s)
 (unless day
 (error "Don't know which date to convert"))
 (setq date (calendar-gregorian-from-absolute day))
 (setq s (concat
 "Gregorian:  " (calendar-date-string date) "\n"
 "ISO:        " (calendar-iso-date-string date) "\n"
 "Day of Yr:  " (calendar-day-of-year-string date) "\n"
 "Julian:     " (calendar-julian-date-string date) "\n"
 "Astron. JD: " (calendar-astro-date-string date)
 article (match-string 3 path))
 (org-follow-rmail-link folder article)))
 ((string= type "shell")
 (let ((cmd path))
 (while (string-match "@{" cmd)
 (setq cmd (replace-match "<" t t cmd)))
 (while (string-match "@}" cmd)
 (setq cmd (replace-match ">" t t cmd)))
 (if (or (not org-confirm-shell-links)
 (yes-or-no-p (format "Execute \"%s\" in the shell? " cmd)))
 (shell-command cmd)
 (error "Abort"))))
 (setq message-number
 (save-restriction
 (widen)
 (goto-char (point-max))
 (if (re-search-backward
 (concat "^Message-ID:\\s-+" (regexp-quote
 (or article "")))
 nil t)
 (rmail-what-message))))))
 (if message-number
 (progn
 (setq cpltxt (concat
 "bbdb:"
 (or (bbdb-record-name (bbdb-current-record))
 (bbdb-record-company (bbdb-current-record))))
 link (org-make-link cpltxt)))
 ((eq major-mode 'calendar-mode)
 (let ((cd (calendar-cursor-to-date)))
 (setq link
 (format-time-string
 (car org-time-stamp-formats)
 (setq folder (abbreviate-file-name folder))
 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
 folder)
 (setq folder (replace-match "" t t folder)))
 (setq cpltxt (concat author " on: " subject))
 (setq link (concat cpltxt "\n  "
 (org-make-link
 "vm:" folder "#" message-id))))))
 ((eq major-mode 'wl-summary-mode)
 (let* ((msgnum (wl-summary-message-number))
 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
 (wl-message-entity (elmo-msgdb-overview-get-entity
 msgnum (wl-summary-buffer-msgdb)))
 (author (wl-summary-line-from)) ; FIXME: how to get author name?
 (subject "???"))   ; FIXME: How to get subject of email?
 (setq cpltxt (concat author  " on: " subject))
 (setq link (concat cpltxt "\n  "
 (org-make-link
 "wl:" wl-summary-buffer-folder-name
 "#" message-id)))))
 ((eq major-mode 'rmail-mode)
 (let ((folder (buffer-file-name))
 (message-id (mail-fetch-field "message-id"))
 (author (mail-fetch-field "from"))
 (subject (mail-fetch-field "subject")))
 (setq cpltxt (concat author  " on: " subject))
 (setq link (concat cpltxt "\n  "
 (org-make-link
 "rmail:" folder "#" message-id)))))))
 ((eq major-mode 'gnus-group-mode)
 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
 (abbreviate-file-name (buffer-file-name))))
 ;; Add the line number?
 (if (org-xor org-line-numbers-in-file-links arg)
 (setq cpltxt
 (concat cpltxt
 ":" (int-to-string
 (+ (if (bolp) 1 0) (count-lines
 (point-min) (point)))))))
 (setq link (org-make-link cpltxt)))
 ((interactive-p)
 (defun org-xor (a b)
 "Exclusive or."
 (if a (not b) b))
 (defun org-get-header (header)
-"Find a header field in the current buffer."
+"Find a HEADER field in the current buffer."
 (save-excursion
 (goto-char (point-min))
 (let ((case-fold-search t) s)
 (cond
 ((eq header 'from)
 (defconst org-remember-help
 "Select a destination location for the note.
 UP/DOWN=headline   TAB=cycle visibility  [Q]uit   RET/<left>/<right>=Store
 RET at beg-of-buf -> Append to file as level 2 headline
 RET on headline   -> Store as sublevel entry to current headline
-<left>/<right>    -> before/after current headline, same headings level")
+<left>/<right>    -> Before/after current headline, same headings level")
 ;;;###autoload
 (defun org-remember-handler ()
 "Store stuff from remember.el into an org file.
 First prompts for an org file.  If the user just presses return, the value
 If the variable `org-adapt-indentation' is non-nil, the entire text is
 also indented so that it starts in the same column as the headline
 \(i.e. after the stars).
 See also the variable `org-reverse-note-order'."
 (catch 'quit
 (let* ((txt (buffer-substring (point-min) (point-max)))
 (fastp current-prefix-arg)
 (file (if fastp org-default-notes-file (org-get-org-file)))
 (visiting (find-buffer-visiting file))
 (defun org-table-convert-region (beg0 end0 nspace)
 "Convert region to a table.
 The region goes from BEG0 to END0, but these borders will be moved
 slightly, to make sure a beginning of line in the first line is included.
 When NSPACE is non-nil, it indicates the minimum number of spaces that
-separate columns (default: just one space)"
+separate columns (default: just one space)."
 (let* ((beg (min beg0 end0))
 (end (max beg0 end0))
 (tabsep t)
 re)
 (goto-char beg)
 "Copy a field down in the current column.
 If the field at the cursor is empty, copy into it the content of the nearest
 non-empty field above.  With argument N, use the Nth non-empty field.
 If the current field is not empty, it is copied down to the next row, and
 the cursor is moved with it.  Therefore, repeating this command causes the
 column to be filled row-by-row.
 If the variable `org-table-copy-increment' is non-nil and the field is an
 integer, it will be incremented while copying."
 (interactive "p")
 (let* ((colpos (org-table-current-column))
 (field (org-table-get-field))
 cnt)))
 (defun org-table-goto-column (n &optional on-delim force)
 "Move the cursor to the Nth column in the current table line.
 With optional argument ON-DELIM, stop with point before the left delimiter
 of the field.
 If there are less than N fields, just go to after the last delimiter.
 However, when FORCE is non-nil, create new columns if necessary."
 (let ((pos (point-at-eol)))
 (beginning-of-line 1)
 (when (> n 0)
 (backward-char 1)
 (if (looking-at " ") (forward-char 1))))))
 (defun org-at-table-p (&optional table-type)
 "Return t if the cursor is inside an org-type table.
-If TABLE-TYPE is non-nil, also chack for table.el-type tables."
+If TABLE-TYPE is non-nil, also check for table.el-type tables."
 (if org-enable-table-editor
 (save-excursion
 (beginning-of-line 1)
 (looking-at (if table-type org-table-any-line-regexp
 org-table-line-regexp)))
 (org-table-goto-column colpos)
 (org-table-align)
 (org-table-modify-formulas 'swap col (if left (1- col) (1+ col)))))
 (defun org-table-move-row-down ()
-"move table row down."
+"Move table row down."
 (interactive)
 (org-table-move-row nil))
 (defun org-table-move-row-up ()
-"move table row up."
+"Move table row up."
 (interactive)
 (org-table-move-row 'up))
 (defun org-table-move-row (&optional up)
 "Move the current table line down.  With arg UP, move it up."
 (org-table-copy-region beg end 'cut))
 (defun org-table-copy-region (beg end &optional cut)
 "Copy rectangular region in table to clipboard.
 A special clipboard is used which can only be accessed
-with `org-table-paste-rectangle'"
+with `org-table-paste-rectangle'."
 (interactive "rP")
 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
 region cols
 (rpl (if cut "  " nil)))
 (goto-char beg)
 (org-table-check-inside-data-field)
 (setq l01 (count-lines (point-min) (point))
 c01 (org-table-current-column))
 (goto-char end)
 (org-table-check-inside-data-field)
 (setq l02 (count-lines (point-min) (point))
 c02 (org-table-current-column))
 (setq l1 (min l01 l02) l2 (max l01 l02)
 (push (nreverse cols) region)
 (setq l1 (1+ l1)))))
 (setq org-table-clip (nreverse region))
 (if cut (org-table-align))
 org-table-clip))
 (defun org-table-paste-rectangle ()
 "Paste a rectangular region into a table.
 The upper right corner ends up in the current field.  All involved fields
 will be overwritten.  If the rectangle does not fit into the present table,
 the table is enlarged as needed.  The process ignores horizontal separator
 (setq nlines (if arg
 (if (< arg 1)
 (+ (length org-table-clip) arg)
 arg)
 (length org-table-clip)))
 (setq org-table-clip
 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
 nil nlines)))
 (goto-char beg)
 (org-table-paste-rectangle))
 ;; No region, split the current field at point
 (while (> (length ll) lines)
 (setq w (1+ w))
 (setq ll (org-do-wrap words w)))
 ll))
 (t (error "Cannot wrap this")))))
 (defun org-do-wrap (words width)
 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
 (let (lines line)
 (while words
 (defun org-table-toggle-vline-visibility (&optional arg)
 "Toggle the visibility of table vertical lines.
 The effect is immediate and on all tables in the file.
 With prefix ARG, make lines invisible when ARG is positive, make lines
-visible when ARG is not positive"
+visible when ARG is not positive."
 (interactive "P")
 (let ((action (cond
 ((and arg (> (prefix-numeric-value arg) 0)) 'on)
 ((and arg (< (prefix-numeric-value arg) 1)) 'off)
 (t (if (org-in-invisibility-spec-p '(org-table))
 (concat "$" (int-to-string (car x)) "=" (cdr x)))
 alist "::")
 "\n")))
 (defun org-table-get-stored-formulas ()
-"Return an alist withh the t=stored formulas directly after current table."
+"Return an alist with the stored formulas directly after current table."
 (interactive)
 (let (col eq eq-alist strings string)
 (save-excursion
 (goto-char (org-table-end))
 (when (looking-at "\\([ \t]*\n\\)*#\\+TBLFM: *\\(.*\\)")
 "Regular expression matching the current column names.")
 (defvar org-table-local-parameters nil
 "Alist with parameter names, derived from the `$' line.")
 (defun org-table-get-specials ()
-"Get the column nmaes and local parameters for this table."
+"Get the column names and local parameters for this table."
 (save-excursion
 (let ((beg (org-table-begin)) (end (org-table-end))
 names name fields field cnt)
 (setq org-table-column-names nil
 org-table-local-parameters nil)
 (if (string-match "^\\(=sum[vh]?\\)\\([0-9]+\\)$" dfield)
 (setq nlast (1+ (string-to-number (match-string 2 dfield)))
 dfield (match-string 1 dfield)))
 (cond
 ((equal dfield "=sumh")
 (org-table-get-field
 nil (org-table-sum
 (save-excursion (org-table-goto-column 1) (point))
 (point) nlast)))
 ((member dfield '("=sum" "=sumv"))
 (setq col (org-table-current-column)
 bolpos (point-at-bol))
 (org-table-get-field
 nil (org-table-sum
 (save-excursion
 (goto-char (org-table-begin))
 (if (re-search-forward org-table-dataline-regexp bolpos t)
 (progn
 "FIXME:"
 :group 'org-table
 :type 'boolean)
 (defvar org-recalc-commands nil
-"List of commands triggering the reccalculation of a line.
+"List of commands triggering the recalculation of a line.
 Will be filled automatically during use.")
 (defvar org-recalc-marks
 '((" " . "Unmarked: no special line, no automatic recalculation")
 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
 (org-table-insert-column)
 (org-table-goto-column (1+ col)))
 (setq epos (point-at-eol))
 (save-excursion
 (beginning-of-line 1)
 (org-table-get-field
 1 (if (looking-at "^[ \t]*| *\\([#!$* ]\\) *|")
 (concat " "
 (setq new (or forcenew
 (cadr (member (match-string 1) marks))))
 " ")
 " # ")))
 (if (and l1 l2)
 (progn
 A few examples for formulas:
 $1+$2               Sum of first and second field
 $1+$2;%.2f          Same, and format result to two digits after dec.point
 exp($2)+exp($1)     Math functions can be used
 $;%.1f              Reformat current cell to 1 digit after dec.point
-($3-32)*5/9         degrees F -> C conversion
+($3-32)*5/9         Degrees F -> C conversion
 When called with a raw \\[universal-argument] prefix, the formula is applied to the current
 field, and to the same same column in all following rows, until reaching a
 horizontal line or the end of the table.  When the command is called with a
 numeric prefix argument (like M-3 or C-7 or \\[universal-argument] 24), the formula is applied
 (while (string-match "[pnfse]\\(-?[0-9]+\\)" fmt)
 (setq c (string-to-char (match-string 1 fmt))
 n (string-to-number (or (match-string 1 fmt) "")))
 (if (= c ?p) (org-set-calc-mode 'calc-internal-prec n)
 (org-set-calc-mode 'calc-float-format
 (list (cdr (assoc c '((?n. float) (?f. fix)
 (?s. sci) (?e. eng))))
 n)))
 (setq fmt (replace-match "" t t fmt)))
 (when (string-match "[DR]" fmt)
 (org-set-calc-mode 'calc-angle-mode
 (setq ev (calc-eval (cons form modes)
 (if org-table-formula-numbers-only 'num)))
 (when org-table-formula-debug
 (with-output-to-temp-buffer "*Help*"
 (princ (format "Substitution history of formula
 Orig:   %s
 $xyz->  %s
 $1->    %s\n" orig formula form))
 (if (listp ev)
 (princ (format "       %s^\nError:  %s"
 (org-table-goto-column thiscol)
 (or noalign (org-table-align)
 (and all (message "Re-applying formulas to %d lines...done" cnt)))))
 (defun org-table-formula-substitute-names (f)
-"Replace $const with values in stirng F."
+"Replace $const with values in string F."
 (let ((start 0) a n1 n2 nn1 nn2 s (f1 f))
 ;; First, check for column names
 (while (setq start (string-match org-table-column-name-regexp f start))
 (setq start (1+ start))
 (setq a (assoc (match-string 1 f) org-table-column-names))
 (setq f (replace-match s t t f)))
 ;; Parameters and constants
 (setq start 0)
 (while (setq start (string-match "\\$\\([a-zA-Z][a-zA-Z0-9]*\\)" f start))
 (setq start (1+ start))
 (if (setq a (save-match-data
 (org-table-get-constant (match-string 1 f))))
 (setq f (replace-match (concat "(" a ")") t t f))))
 (if org-table-formula-debug
 (put-text-property 0 (length f) :orig-formula f1 f))
 f))
 "Unconditionally turn on `orgtbl-mode'."
 (orgtbl-mode 1))
 ;;;###autoload
 (defun orgtbl-mode (&optional arg)
 "The `org-mode' table editor as a minor mode for use in other modes."
 (interactive)
 (if (eq major-mode 'org-mode)
 ;; Exit without error, in case some hook functions calls this
 ;; by accident in org-mode.
 (message "Orgtbl-mode is not useful in org-mode, command ignored")
 (add-hook 'before-change-functions 'org-before-change-function
 nil 'local)
 (set (make-local-variable 'org-old-auto-fill-inhibit-regexp)
 auto-fill-inhibit-regexp)
 (set (make-local-variable 'auto-fill-inhibit-regexp)
 (if auto-fill-inhibit-regexp
 (concat "\\([ \t]*|\\|" auto-fill-inhibit-regexp)
 "[ \t]*|"))
 (easy-menu-add orgtbl-mode-menu)
 (run-hooks 'orgtbl-mode-hook))
 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
 (put 'orgtbl-mode :menu-tag "Org Table Mode")
 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
 (defun orgtbl-make-binding (fun n &rest keys)
 "Create a function for binding in the table minor mode.
-FUN is the command to call inside a table. N is used to create a unique
+FUN is the command to call inside a table.  N is used to create a unique
-command name. KEYS are keys that should be checked in for a command
+command name.  KEYS are keys that should be checked in for a command
 to execute outside of tables."
 (eval
 (list 'defun
 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
 '(arg)
 (concat "In tables, run `" (symbol-name fun) "'.\n"
 "Outside of tables, run the binding of `"
 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
 '('orgtbl-error))))))))
 (defun orgtbl-error ()
 "Error when there is no default binding for a table key."
 (interactive)
-(error "This key is has no function outside tables"))
+(error "This key has no function outside tables"))
 (defun orgtbl-setup ()
 "Setup orgtbl keymaps."
 (let ((nfunc 0)
 (bindings
 (setq key (car elt)
 fun (nth 1 elt)
 cmd (orgtbl-make-binding fun nfunc key))
 (define-key orgtbl-mode-map key cmd))
 ;; Special treatment needed for TAB and RET
 (define-key orgtbl-mode-map [(return)]
 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
 (define-key orgtbl-mode-map "\C-m"
 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
 (define-key orgtbl-mode-map [(tab)]
 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
 (define-key orgtbl-mode-map "\C-i"
 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)])))
 (when orgtbl-optimized
 ;; If the user wants maximum table support, we need to hijack
 ["Eval Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
 ["Eval Formula Down " (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
 ["Sum Column/Rectangle" org-table-sum
 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
 ["Debug Formulas"
 (setq org-table-formula-debug (not org-table-formula-debug))
 :style toggle :selected org-table-formula-debug]
 and all options lines."
 (interactive)
 (let* ((filename (concat (file-name-sans-extension (buffer-file-name))
 ".txt"))
 (buffer (find-file-noselect filename))
 (ore (concat
 (org-make-options-regexp
 '("CATEGORY" "SEQ_TODO" "PRI_TODO" "TYP_TODO"
 "STARTUP" "ARCHIVE"
 "TITLE" "AUTHOR" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"))
 (if org-noutline-p "\\(\n\\|$\\)" "")))
 (mapcar '(lambda (line)
 (if (string-match org-todo-line-regexp line)
 ;; This is a headline
 (progn
 (setq level (- (match-end 1) (match-beginning 1))
 txt (save-match-data
 (org-html-expand
 (match-string 3 line)))
 todo
 (or (and (match-beginning 2)
 (not (equal (match-string 2 line)
 (org-format-table-table-html lines)
 ;; Need to use the code generator in table.el, with the original text.
 (org-format-table-table-html-using-table-generate-source olines)))))
 (defun org-format-org-table-html (lines)
-"Format a table into html."
+"Format a table into HTML."
 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
 (setq lines (nreverse lines))
 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
 (setq lines (nreverse lines))
 (let ((head (and org-export-highlight-first-table-line
 (if (not (eq (aref newstr i) ?|))
 	  (aset newstr i ?\ )))
 newstr))
 (defun org-format-table-table-html (lines)
-"Format a table generated by table.el into html.
+"Format a table generated by table.el into HTML.
 This conversion does *not* use `table-generate-source' from table.el.
 This has the advantage that Org-mode's HTML conversions can be used.
 But it has the disadvantage, that no cell- or row-spanning is allowed."
 (let (line field-buffer
 (head org-export-highlight-first-table-line)
 (setq field-buffer fields))))
 (setq html (concat html "</table>\n"))
 html))
 (defun org-format-table-table-html-using-table-generate-source (lines)
-"Format a table into html, using `table-generate-source' from table.el.
+"Format a table into HTML, using `table-generate-source' from table.el.
 This has the advantage that cell- or row-spanning is allowed.
 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
 (require 'table)
 (with-current-buffer (get-buffer-create " org-tmp1 ")
 (erase-buffer)
 reduced column width."
 (interactive "p")
 (if (and (org-table-p)
 (eq N 1)
 (string-match "|" (buffer-substring (point-at-bol) (point)))
 (looking-at ".*?|"))
 (let ((pos (point)))
 (backward-delete-char N)
 (skip-chars-forward "^|")
 (insert " ")
 (goto-char (1- pos)))
 (t (org-priority-down))))
 (defun org-copy-special ()
 "Call either `org-table-copy' or `org-copy-subtree'."
 (interactive)
 (call-interactively
 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
 (defun org-cut-special ()
 "Call either `org-table-copy' or `org-cut-subtree'."
 (interactive)
 (defun org-ctrl-c-ctrl-c (&optional arg)
 "Call realign table, or recognize a table.el table, or update keywords.
 When the cursor is inside a table created by the table.el package,
 activate that table.  Otherwise, if the cursor is at a normal table
 created with org.el, re-align that table.  This command works even if
 the automatic table editor has been turned off.
 If the cursor is in one of the special #+KEYWORD lines, this triggers
 scanning the buffer for these lines and updating the information."
 (interactive "P")
 (let  ((org-enable-table-editor t))
 (cond
 ["Eval Formula" org-table-eval-formula (org-at-table-p)]
 ["Eval Formula Down" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
 ["Recalculate line" org-table-recalculate (org-at-table-p)]
 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
 ["Sum Column/Rectangle" org-table-sum
 (or (org-at-table-p) (org-region-active-p))]
 ["Which Column?" org-table-current-column (org-at-table-p)])
 ["Debug Formulas"
 (setq org-table-formula-debug (not org-table-formula-debug))
 :style toggle :selected org-table-formula-debug]
 (interactive)
 (require 'info)
 (Info-goto-node (format "(org)%s" (or node ""))))
 (defun org-install-agenda-files-menu ()
 (easy-menu-change
 '("Org") "File List for Agenda"
 (append
 (list
 ["Edit File List" (customize-variable 'org-agenda-files) t]
 ["Add Current File to List" org-add-file t]
 ["Remove Current File from List" org-remove-file t]
 "--")
 (mapcar 'org-file-menu-entry org-agenda-files))))
 ;;; Documentation
 (defun org-customize ()
-"Call the customize function with org as argument."
+"Call the customize function with `org' as argument."
 (interactive)
 (customize-browse 'org))
 (defun org-create-customize-menu ()
 "Create a full customization menu for Org-mode, insert it into the menu."
 "\\'"))))
 ;; Functions needed for compatibility with old outline.el
 ;; The following functions capture almost the entire compatibility code
 ;; between the different versions of outline-mode.  The only other place
 ;; where this is important are the font-lock-keywords.  Search for
 ;; `org-noutline-p' to find it.
 ;; C-a should go to the beginning of a *visible* line, also in the
 ;; new outline.el.  I guess this should be patched into Emacs?
 (save-excursion
 (skip-chars-backward "^\r\n")
 (equal (char-before) ?\r))))
 (defun org-back-to-heading (&optional invisible-ok)
-"Move to previous heading line, or beg of this line if it's a heading.
+"Move to previous heading line, or beginning of this line if it's a heading.
 Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
 (if org-noutline-p
 (outline-back-to-heading invisible-ok)
 (if (looking-at outline-regexp)
 t
 (defun org-up-heading-all (arg)
 "Move to the heading line of which the present line is a subheading.
 This function considers both visible and invisible heading lines.
 With argument, move up ARG levels."
 (if org-noutline-p
 (if (fboundp 'outline-up-heading-all)
 (outline-up-heading-all arg)   ; emacs 21 version of outline.el
 (outline-up-heading arg t))      ; emacs 22 version of outline.el
 (org-back-to-heading t)
 (looking-at outline-regexp)
 (if (<= (- (match-end 0) (match-beginning 0)) arg)
 flag
 (if flag ?\r ?\n))))))
 (defun org-show-subtree ()
 "Show everything after this heading at deeper levels."
 (outline-flag-region
 (point)
 (save-excursion
 (outline-end-of-subtree) (outline-next-heading) (point))
 (if org-noutline-p nil ?\n)))
 (defun org-show-entry ()
 "Show the body directly following this heading.
 Show the heading too, if it is currently invisible."
 (interactive)
 (save-excursion
 (org-back-to-heading t)
 (outline-flag-region
 (1- (point))
 (save-excursion
 (re-search-forward (concat "[\r\n]\\(" outline-regexp "\\)") nil 'move)
 (or (match-beginning 1) (point-max)))
 (if org-noutline-p nil ?\n))))

Mercurial > emacs

comparison lisp/textmodes/org.el @ 63902:0b526dc24ccb