changeset 69121:39ec690b89d6

(org-xemacs-p, org-export-html-show-new-buffer, org-table-may-need-update, org-insert-item, org-mhe-get-message-real-folder, org-mhe-get-message-folder-from-index, org-mhe-get-message-folder, org-mhe-get-message-num, org-mhe-get-header, org-make-org-heading-search-string, org-make-org-heading-camel, org-table-sort-lines, org-format-org-table-html, org-format-table-table-html): Fix typos in docstrings.

--- a/lisp/textmodes/org.el	Thu Feb 23 13:31:03 2006 +0000
+++ b/lisp/textmodes/org.el	Thu Feb 23 14:40:40 2006 +0000
@@ -140,7 +140,7 @@
 ;; versions (Emacs versus XEmacs) and with different versions of outline.el.
 ;; The compatibility code in org.el is based on these two constants.
 (defconst org-xemacs-p (featurep 'xemacs)
-  "Are we running xemacs?")
+  "Are we running XEmacs?")
 (defconst org-noutline-p (featurep 'noutline)
   "Are we using the new outline mode?")
 
@@ -1651,7 +1651,7 @@
   :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)
@@ -1999,8 +1999,8 @@
 ;; an update.
 (defvar org-table-may-need-update t
   "Indicates that a table might need an update.
-This variable is set by `org-before-change-function'. `org-table-align'
-sets it back to nil.")
+This variable is set by `org-before-change-function'.
+`org-table-align'sets it back to nil.")
 (defvar org-mode-hook nil)
 (defvar org-inhibit-startup nil)        ; Dynamically-scoped param.
 (defvar org-agenda-keep-modes nil)      ; Dynamically-scoped param.
@@ -2660,7 +2660,7 @@
 
 (defun org-insert-item ()
   "Insert a new item at the current level.
-Return t when tings worked, nil when we are not in an item."
+Return t when things worked, nil when we are not in an item."
   (when (save-excursion
 	  (condition-case nil
 	      (progn
@@ -3371,7 +3371,7 @@
 		    (save-excursion
 		      (goto-char (point-min))
 		      (while (re-search-forward org-todo-line-regexp nil t)
-			(push (list 
+			(push (list
 			       (if org-file-link-context-use-camel-case
 				   (org-make-org-heading-camel (match-string 3) t)
 				 (org-make-org-heading-search-string
@@ -6988,7 +6988,7 @@
   (interactive)
   (setq pos (or pos (point)))
   (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
-  (move-marker (car org-mark-ring) 
+  (move-marker (car org-mark-ring)
 	       (or pos (point))
 	       (or buffer (current-buffer)))
   (message
@@ -7136,14 +7136,14 @@
 ;; mh-e integration based on planner-mode
 (defun org-mhe-get-message-real-folder ()
   "Return the name of the current message real folder, so if you use
-  sequences, it will now work."
+sequences, it will now work."
   (save-excursion
     (let* ((folder
             (if (equal major-mode 'mh-folder-mode)
                 mh-current-folder
               ;; Refer to the show buffer
               mh-show-folder-buffer))
-           (end-index 
+           (end-index
             (if (boundp 'mh-index-folder)
                 (min (length mh-index-folder) (length folder))))
            )
@@ -7166,8 +7166,7 @@
       )))
 
 (defun org-mhe-get-message-folder-from-index ()
-  "Returns the name of the message folder in a index folder
-  buffer."
+  "Returns the name of the message folder in a index folder buffer."
   (save-excursion
     (mh-index-previous-folder)
     (if (not (re-search-forward "^\\(+.*\\)$" nil t))
@@ -7175,8 +7174,8 @@
       (message (match-string 1)))))
 
 (defun org-mhe-get-message-folder ()
-  "Return the name of the current message folder. Be careful if you
-  use sequences."
+  "Return the name of the current message folder.  Be careful if you
+use sequences."
   (save-excursion
     (if (equal major-mode 'mh-folder-mode)
         mh-current-folder
@@ -7184,8 +7183,8 @@
       mh-show-folder-buffer)))
 
 (defun org-mhe-get-message-num ()
-  "Return the number of the current message. Be careful if you
-  use sequences."
+  "Return the number of the current message.  Be careful if you
+use sequences."
   (save-excursion
     (if (equal major-mode 'mh-folder-mode)
         (mh-get-msg-num nil)
@@ -7193,9 +7192,9 @@
       (mh-show-buffer-message-number))))
 
 (defun org-mhe-get-header (header)
-  "Return a header of the message in folder mode. This will create a
-  show buffer for the corresponding message. If you have a more clever
-  idea..."
+  "Return a header of the message in folder mode.  This will create a
+show buffer for the corresponding message.  If you have a more clever
+idea..."
   (let* ((folder (org-mhe-get-message-folder))
          (num (org-mhe-get-message-num))
          (buffer (get-buffer-create (concat "show-" folder)))
@@ -7222,7 +7221,7 @@
     (get-buffer-create show-buf)
     (mh-show-msg
      (string-to-number
-      (car (split-string 
+      (car (split-string
 	    (with-temp-buffer
 	      (call-process
 	       (expand-file-name "pick" mh-progs)
@@ -7387,7 +7386,7 @@
 	(setq cpltxt (concat from-header " on: " subject))
 	(setq link (concat cpltxt "\n  "
 			   (org-make-link
-			    "mhe:" (org-mhe-get-message-real-folder) "#" 
+			    "mhe:" (org-mhe-get-message-real-folder) "#"
 			    (org-remove-angle-brackets
 			     (org-mhe-get-header "Message-Id:")))))))
 
@@ -7495,7 +7494,7 @@
       (error "Cannot link to a buffer which is not visiting a file"))
 
      (t (setq link nil)))
-    
+
     (if (and (interactive-p) link)
 	(progn
 	  (setq org-stored-links
@@ -7504,7 +7503,7 @@
       link)))
 
 (defun org-make-org-heading-search-string (&optional string heading)
-  "Make search string for S or current headline."
+  "Make search string for STRING or current headline."
   (interactive)
   (let ((s (or string (org-get-heading))))
     (unless (and string (not heading))
@@ -7525,7 +7524,7 @@
     (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
 
 (defun org-make-org-heading-camel (&optional string heading)
-  "Make a CamelCase string for S or the current headline."
+  "Make a CamelCase string for STRING or the current headline."
   (interactive)
   (let ((s (or string (org-get-heading))))
     (unless (and string (not heading))
@@ -8642,8 +8641,8 @@
 mark should be in the column that is used for sorting.  For example, to
 sort according to column 3, put the mark in the first line to sort, in
 table column 3.  Put point into the last line to be included in the sorting,
-also in table column 3. The command will prompt for the sorting method (n for
-numerical, a for alphanumeric)."
+also in table column 3.  The command will prompt for the sorting method
+\(n for numerical, a for alphanumeric)."
   (interactive "r\nsSorting method: [n]=numeric [a]=alpha: ")
   (setq numericp (string-match "[nN]" numericp))
   (org-table-align) ;; Just to be safe
@@ -9482,8 +9481,8 @@
 	    (if (= c ?p) (setq modes (org-set-calc-mode 'calc-internal-prec n))
 	      (setq modes (org-set-calc-mode
 			   'calc-float-format
-			   (list (cdr (assoc c '((?n. float) (?f. fix)
-						 (?s. sci) (?e. eng))))
+			   (list (cdr (assoc c '((?n . float) (?f . fix)
+						 (?s . sci) (?e . eng))))
 				 n))))
 	    (setq fmt (replace-match "" t t fmt)))
 	  (while (string-match "[DRFS]" fmt)
@@ -11004,7 +11003,7 @@
 	  ;; make targets to anchors
 	  (while (string-match "<<<?\\([^<>]*\\)>>>?[ \t]*\n?" line)
 	    (setq line (replace-match
-			(concat "@<a name=\"" 
+			(concat "@<a name=\""
 				(org-solidify-link-text (match-string 1 line))
 				"\">\\nbsp@</a>")
 			t t line)))
@@ -11012,7 +11011,7 @@
 	  (while (string-match org-bracket-link-regexp line)
 	    (setq line (replace-match
 			(concat
-			    "@<a href=\"#" 
+			    "@<a href=\"#"
 			    (org-solidify-link-text (match-string 1 line))
 			    "\">"
 			    (match-string (if (match-end 3) 3 1) line)
@@ -11197,7 +11196,7 @@
 	(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)))
@@ -11224,7 +11223,7 @@
 				    (string-match "^[ \t]*|[^|]*|" x))
 				(replace-match "|" t t x))))
 		       lines))))))
-  
+
   (let ((head (and org-export-highlight-first-table-line
 		   (delq nil (mapcar
 			      (lambda (x) (string-match "^[ \t]*|-" x))
@@ -11263,7 +11262,7 @@
     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."