[AUCTeX-devel] patch for small doc fix

[Ikumi Keita]

Dear AUCTeX developpers,

 Here is a small patch to make AUCTeX conform to elisp coding
conventions quoted below from emacs lisp reference, with an addition of
the command "textasteriskcentered" to LaTeX default completion
candidates.  I hope this helps.

   * When you mention a default value in a minibuffer prompt, put it
     and the word `default' inside parentheses.  It should look like
     this:

          Enter the answer (default 42):

   * Many commands that take a long time to execute display a message
     that says something like `Operating...' when they start, and
     change it to `Operating...done' when they finish.  Please keep the
     style of these messages uniform: _no_ space around the ellipsis,
     and _no_ period after `done'.

Regards,
Ikumi Keita

--- tex.el-11.86        2010-02-21 00:01:35.000000000 +0900
+++ tex.el      2012-05-05 03:20:35.000000000 +0900
@@ -1816,7 +1816,7 @@
     (let* ((default (TeX-dwim-master))
           (name (or (and (eq 'dwim TeX-master) default)
                     (condition-case nil
-                        (read-file-name (format "Master file: (default %s) "
+                        (read-file-name (format "Master file (default %s): "
                                                 (or default "this file"))
                                         nil default)
                       (quit "<quit>")))))
@@ -1877,7 +1877,7 @@
          (setq TeX-master
                (let* ((default (TeX-dwim-master))
                       (name (read-file-name
-                             (format "Master file: (default %s) "
+                             (format "Master file (default %s): "
                                      (or default "this file"))
                              nil default)))
                  (cond ((string= name default)
@@ -2327,7 +2327,7 @@
                                    TeX-style-hook-list))))
        (TeX-auto-apply))
     (run-hooks 'TeX-update-style-hook)
-    (message "Applying style hooks... done")))
+    (message "Applying style hooks...done")))
 
 (defvar TeX-remove-style-hook nil
   "List of hooks to call when we remove the style specific information.")
@@ -3123,7 +3123,7 @@
              (if (> (length next) (length this))
                  (setcdr this (cdr next)))
              (setcdr entry (cdr (cdr entry)))))))
-      (message "Removing duplicates... done"))
+      (message "Removing duplicates...done"))
     (symbol-value local)))
 
 (TeX-auto-add-type "symbol" "TeX")
@@ -3243,7 +3243,7 @@
                                                        t)
                                   ".el"))
           (kill-buffer (current-buffer))
-          (message "Parsing %s... done" tex)))))
+          (message "Parsing %s...done" tex)))))
 
 ;;;###autoload
 (defun TeX-auto-generate-global ()
--- tex-buf.el-11.86    2009-12-13 03:43:57.000000000 +0900
+++ tex-buf.el  2012-05-05 03:17:00.000000000 +0900
@@ -427,7 +427,7 @@
         (completion-ignore-case t)
         (answer (or TeX-command-force
                     (completing-read
-                     (concat "Command: (default " default ") ")
+                     (concat "Command (default " default "): ")
                      (TeX-mode-specific-command-list major-mode) nil t
                      nil 'TeX-command-history))))
     ;; If the answer "latex" it will not be expanded to "LaTeX"
@@ -455,10 +455,9 @@
             (setq printer (if TeX-printer-list
                               (let ((completion-ignore-case t))
                                 (completing-read
-                                 (concat "Printer: "
-                                         (and TeX-printer-default
-                                              (concat "(default "
-                                                      TeX-printer-default ") 
")))
+                                 (format "Printer%s: "
+                                         (if TeX-printer-default
+                                             (format " (default %s)" 
TeX-printer-default) ""))
                                  TeX-printer-list))
                             ""))
             (setq printer (or (car-safe (TeX-assoc printer TeX-printer-list))
--- latex.el-11.86      2009-11-01 02:03:28.000000000 +0900
+++ latex.el    2012-05-08 23:30:54.000000000 +0900
@@ -417,7 +417,7 @@
 Insert this hook into `LaTeX-section-hook' to allow the user to change
 the name of the sectioning command inserted with `\\[LaTeX-section]'."
   (let ((string (completing-read
-                (concat "Level: (default " name ") ")
+                (concat "Level (default " name "): ")
                 LaTeX-section-list
                 nil nil nil)))
     ; Update name
@@ -521,11 +521,11 @@
 `LaTeX-default-position'          Position for array and tabular."
 
   (interactive "*P")
-  (let ((environment (completing-read (concat "Environment type: (default "
+  (let ((environment (completing-read (concat "Environment type (default "
                                               (if (TeX-near-bobp)
                                                   "document"
                                                 LaTeX-default-environment)
-                                              ") ")
+                                              "): ")
                                      (LaTeX-environment-list)
                                      nil nil nil
                                      'LaTeX-environment-history)))
@@ -1453,7 +1453,7 @@
   (let (tag)
     (setq prompt (concat (if optional "(Optional) " "")
                         (if prompt prompt "Index tag")
-                        ": (default none) "))
+                        " (default none): "))
     (setq tag (read-string prompt))
     (TeX-argument-insert tag optional)))
 
@@ -1508,7 +1508,7 @@
 string.  DEFINITION is unused."
   (setq prompt (concat (if optional "(Optional) " "")
                       (if prompt prompt "Add key")
-                      ": (default none) "))
+                      " (default none): "))
   (let ((items (multi-prompt "," t prompt (LaTeX-bibitem-list))))
     (apply 'LaTeX-add-bibitems items)
     (TeX-argument-insert (mapconcat 'identity items ",") optional optional)))
@@ -1613,7 +1613,7 @@
   "Insert arguments to documentclass.
 OPTIONAL and IGNORE are ignored."
   (let ((style (completing-read
-               (concat "Document class: (default " LaTeX-default-style ") ")
+               (concat "Document class (default " LaTeX-default-style "): ")
                LaTeX-style-list))
        (options (read-string "Options: "
                              (if (stringp LaTeX-default-options)
@@ -1815,8 +1815,8 @@
 If OPTIONAL is non-nil, insert the resulting value as an optional
 argument, otherwise as a mandatory one.  IGNORE is ignored."
   (let ((del (read-quoted-char
-             (concat "Delimiter: (default "
-                     (char-to-string LaTeX-default-verb-delimiter) ") "))))
+             (concat "Delimiter (default "
+                     (char-to-string LaTeX-default-verb-delimiter) "): "))))
     (when (<= del ?\ ) (setq del LaTeX-default-verb-delimiter))
     (if (TeX-active-mark)
        (progn
@@ -3366,7 +3366,7 @@
       (setq from (point))
       (catch 'end-of-buffer
        (while (and (< (point) to))
-         (message "Formatting%s ... %d%%"
+         (message "Formatting%s... %d%%"
                   (or what "")
                   (/ (* 100 (- (point) from)) (- to from)))
          (save-excursion (LaTeX-fill-paragraph justify))
@@ -3383,7 +3383,7 @@
                               TeX-comment-start-regexp "+[ \t]*$\\)")))
            (forward-line 1))))
       (set-marker to nil)))
-  (message "Finished"))
+  (message "Formatting%s...done" (or what "")))
 
 (defun LaTeX-find-matching-end ()
   "Move point to the \\end of the current environment.
@@ -5316,7 +5316,7 @@
      "textcompwordmark" "textvisiblespace" "textemdash" "textendash"
      "textexclamdown" "textquestiondown" "textquotedblleft"
      "textquotedblright" "textquoteleft" "textquoteright"
-     "textbullet" "textperiodcentered"
+     "textbullet" "textperiodcentered" "textasteriskcentered"
      "textbackslash" "textbar" "textless" "textgreater"
      "textasciicircum" "textasciitilde"
      "textregistered" "texttrademark"