Modified description about '$' mark.
[elisp/wanderlust.git] / utils / ptexinfmt.el
index 711ccd5..e98956e 100644 (file)
@@ -3,7 +3,7 @@
 ;; Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993,
 ;;               1994, 1995, 1996, 1997 Free Software Foundation, Inc.
 ;; Copyright (C) 1999 Yoshiki Hayashi <yoshiki@xemacs.org>
-;; Copyright (C) 2000 TAKAHASHI Kaoru <kaoru@kaisei.org>
+;; Copyright (C) 2000, 2001 TAKAHASHI Kaoru <kaoru@kaisei.org>
 
 ;; Author: TAKAHASHI Kaoru <kaoru@kaisei.org>
 ;;     Yoshiki Hayashi <yoshiki@xemacs.org>
 (require 'poe)
 (require 'broken)
 
-(provide 'ptexinfmt)
-
 ;;; Broken
-(defvar ptexinfmt-disable-broken-notice t
-  "If non-nil disable notice, when call `broken-facility'.")
+(defvar ptexinfmt-disable-broken-notice-flag t
+  "If non-nil disable notice, when call `broken-facility'.
+This is NO-NOTICE argument in `broken-facility'.")
 
 ;; sort -fd
 (broken-facility texinfo-format-printindex
   (if (and (memq system-type '(windows-nt ms-dos))
 ;;; I don't know version threshold. 
 ;;;       (string< texinfmt-version "2.37 of 24 May 1997")
-          (boundp 'MULE) (not (featurep 'meadow)))
+          (boundp 'MULE) (not (featurep 'meadow))) ; Mule for Windows
       nil
     t)
-  ptexinfmt-disable-broken-notice)
+  ptexinfmt-disable-broken-notice-flag)
 
 ;; @var
 (broken-facility texinfo-format-var
@@ -66,7 +65,7 @@
          (texinfo-format-expand-region (point-min) (point-max))
          t))
     (error nil))
-  ptexinfmt-disable-broken-notice)
+  ptexinfmt-disable-broken-notice-flag)
 
 ;; @xref
 (broken-facility texinfo-format-xref
@@ -79,7 +78,7 @@
          (texinfo-format-expand-region (point-min) (point-max))
          t))
     (error nil))
-  ptexinfmt-disable-broken-notice)
+  ptexinfmt-disable-broken-notice-flag)
 
 ;; @uref
 (broken-facility texinfo-format-uref
          (texinfo-format-expand-region (point-min) (point-max))
          t))
     (error nil))
-  ptexinfmt-disable-broken-notice)
+  ptexinfmt-disable-broken-notice-flag)
 
 ;; @multitable
 (broken-facility texinfo-multitable-widths
-  "texinfo-multitable-widths unsupport wide-char."
+  "`texinfo-multitable-widths' unsupport wide-char."
   (if (fboundp 'texinfo-multitable-widths)
       (with-temp-buffer
        (let ((str "\e$BI}9-J8;z\e(B"))
            t)))
     ;; function definition is void
     t)
-  ptexinfmt-disable-broken-notice)
+  ptexinfmt-disable-broken-notice-flag)
 
 (broken-facility texinfo-multitable-item
-  "texinfo-multitable-item unsupport wide-char."
+  "`texinfo-multitable-item' unsupport wide-char."
   (if-broken texinfo-multitable-widths nil t)
-  ptexinfmt-disable-broken-notice)
+  ptexinfmt-disable-broken-notice-flag)
 
 
 ;;; Obsolete
 
 ;; size
 (put 'smallbook 'texinfo-format 'texinfo-discard-line)
+(put 'letterpaper 'texinfo-format 'texinfo-discard-line)
 (put 'afourpaper 'texinfo-format 'texinfo-discard-line)
 (put 'afourlatex 'texinfo-format 'texinfo-discard-line)
 (put 'afourwide 'texinfo-format 'texinfo-discard-line)
+(put 'afivepaper 'texinfo-format 'texinfo-discard-line)
 (put 'pagesizes 'texinfo-format 'texinfo-discard-line-with-args)
 
 ;; style
 (defun-maybe texinfo-format-direntry ()
   (texinfo-push-stack 'direntry nil)
   (texinfo-discard-line)
-  (insert "START-INFO-DIR-ENTRY\n\n"))
+  (insert "START-INFO-DIR-ENTRY\n"))
 
 (put 'direntry 'texinfo-end 'texinfo-end-direntry)
 (defun-maybe texinfo-end-direntry ()
@@ -484,7 +485,8 @@ otherwise, insert URL-TITLE followed by URL in parentheses."
 ;; @image{FILENAME, [WIDTH], [HEIGHT]}
 (put 'image 'texinfo-format 'texinfo-format-image)
 (defun-maybe texinfo-format-image ()
-  (let ((args (texinfo-format-parse-args)) ; parse FILENAME?
+  ;; I don't know makeinfo parse FILENAME.
+  (let ((args (texinfo-format-parse-args))
        filename)
     (when (null (nth 0 args))
       (error "Invalid image command"))
@@ -755,4 +757,6 @@ This command is executed when texinfmt sees @item inside @multitable."
         (texinfo-sort-region opoint (point))
       (shell-command-on-region opoint (point) "sort -fd" 1))))
 
+(provide 'ptexinfmt)
+
 ;;; ptexinfmt.el ends here