1 ;;; texinfo.el --- major mode for editing Texinfo files.
3 ;; Copyright (C) 1985, 1988, 1989, 1990 Free Software Foundation, Inc.
5 ;; Author: Bob Chassell <bob@gnu.ai.mit.edu>
7 ;; Keywords: maint, tex, doc, wp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
29 (defvar texinfo-mode-syntax-table nil)
31 (if texinfo-mode-syntax-table
33 (setq texinfo-mode-syntax-table (make-syntax-table))
34 (modify-syntax-entry ?\" " " texinfo-mode-syntax-table)
35 (modify-syntax-entry ?\\ " " texinfo-mode-syntax-table)
36 (modify-syntax-entry ?@ "\\" texinfo-mode-syntax-table)
37 (modify-syntax-entry ?\^q "\\" texinfo-mode-syntax-table)
38 (modify-syntax-entry ?\[ "(]" texinfo-mode-syntax-table)
39 (modify-syntax-entry ?\] ")[" texinfo-mode-syntax-table)
40 (modify-syntax-entry ?{ "(}" texinfo-mode-syntax-table)
41 (modify-syntax-entry ?} "){" texinfo-mode-syntax-table)
42 (modify-syntax-entry ?\' "w" texinfo-mode-syntax-table))
44 (defvar texinfo-mode-map nil)
46 ;; Mode documentation displays commands in reverse order
47 ;; from how they are listed in the texinfo-mode-map.
50 (setq texinfo-mode-map (make-sparse-keymap))
52 (define-key texinfo-mode-map "\C-c\C-t\C-k" 'tex-kill-job)
53 (define-key texinfo-mode-map "\C-c\C-t\C-l" 'tex-recenter-output-buffer)
54 (define-key texinfo-mode-map "\C-c\C-t\C-q" 'tex-show-print-queue)
55 (define-key texinfo-mode-map "\C-c\C-t\C-p" 'texinfo-tex-print)
56 ;; (define-key texinfo-mode-map "\C-c\C-t\C-i" 'texinfo-texindex)
57 (define-key texinfo-mode-map "\C-c\C-t\C-t" 'texinfo-tex-buffer)
58 (define-key texinfo-mode-map "\C-c\C-t\C-r" 'texinfo-tex-region)
60 (define-key texinfo-mode-map "\C-c\C-i\C-r" 'texinfo-format-region)
61 (define-key texinfo-mode-map "\C-c\C-i\C-b" 'texinfo-format-buffer)
63 (define-key texinfo-mode-map "\C-c\C-u\C-m" 'texinfo-make-menu)
64 (define-key texinfo-mode-map "\C-c\C-u\C-n" 'texinfo-update-node)
65 (define-key texinfo-mode-map "\C-c\C-u\C-e" 'texinfo-every-node-update)
66 (define-key texinfo-mode-map "\C-c\C-u\C-a" 'texinfo-all-menus-update)
68 (define-key texinfo-mode-map "\C-c\C-s" 'texinfo-show-structure)
70 (define-key texinfo-mode-map "\"" 'tex-insert-quote)
71 (define-key texinfo-mode-map "\C-c}" 'up-list)
72 (define-key texinfo-mode-map "\C-c{" 'texinfo-insert-braces)
74 (define-key texinfo-mode-map "\C-c\C-cv" 'texinfo-insert-@var)
75 (define-key texinfo-mode-map "\C-c\C-cs" 'texinfo-insert-@samp)
76 (define-key texinfo-mode-map "\C-c\C-co" 'texinfo-insert-@noindent)
77 (define-key texinfo-mode-map "\C-c\C-cn" 'texinfo-insert-@node)
78 (define-key texinfo-mode-map "\C-c\C-ck" 'texinfo-insert-@kbd)
79 (define-key texinfo-mode-map "\C-c\C-ci" 'texinfo-insert-@item)
80 (define-key texinfo-mode-map "\C-c\C-cx" 'texinfo-insert-@example)
81 (define-key texinfo-mode-map "\C-c\C-ce" 'texinfo-insert-@end-example)
82 (define-key texinfo-mode-map "\C-c\C-cd" 'texinfo-insert-@dfn)
83 (define-key texinfo-mode-map "\C-c\C-cc" 'texinfo-insert-@code))
85 (defun texinfo-insert-@var ()
86 "Insert the string @var in a texinfo buffer."
91 (defun texinfo-insert-@samp ()
92 "Insert the string @samp in a texinfo buffer."
97 (defun texinfo-insert-@noindent ()
98 "Insert the string @noindent in a texinfo buffer."
100 (insert "@noindent\n"))
102 (defun texinfo-insert-@node ()
103 "Insert the string @node in a texinfo buffer,
104 along with a comment indicating the arguments to @node."
106 (insert "@node \n@comment node-name, next, previous, up")
110 (defun texinfo-insert-@kbd ()
111 "Insert the string @kbd in a texinfo buffer."
116 (defun texinfo-insert-@item ()
117 "Insert the string @item in a texinfo buffer."
122 (defun texinfo-insert-@example ()
123 "Insert the string @example in a texinfo buffer."
125 (insert "@example\n"))
127 (defun texinfo-insert-@end-example ()
128 "Insert the string @end example in a texinfo buffer."
130 (insert "@end example\n"))
132 (defun texinfo-insert-@dfn ()
133 "Insert the string @dfn in a texinfo buffer."
138 (defun texinfo-insert-@code ()
139 "Insert the string @code in a texinfo buffer."
144 (defun texinfo-insert-braces ()
145 "Make a pair of braces and be poised to type inside of them.
146 Use \\[up-list] to move forward out of the braces."
152 (defun texinfo-mode ()
153 "Major mode for editing Texinfo files.
155 It has these extra commands:
158 These are files that are used as input for TeX to make printed manuals
159 and also to be turned into Info files by \\[texinfo-format-buffer] or
160 `makeinfo'. These files must be written in a very restricted and
161 modified version of TeX input format.
163 Editing commands are like text-mode except that the syntax table is
164 set up so expression commands skip Texinfo bracket groups. To see
165 what the Info version of a region of the Texinfo file will look like,
166 use \\[texinfo-format-region]. This command runs Info on the current region
167 of the Texinfo file and formats it properly.
169 You can show the structure of a Texinfo file with \\[texinfo-show-structure].
170 This command shows the structure of a Texinfo file by listing the
171 lines with the @-sign commands for @chapter, @section, and the like.
172 These lines are displayed in another window called the *Occur* window.
173 In that window, you can position the cursor over one of the lines and
174 use \\[occur-mode-goto-occurrence], to jump to the corresponding spot
177 In addition, Texinfo mode provides commands that insert various
178 frequently used @-sign commands into the buffer. You can use these
179 commands to save keystrokes. And you can insert balanced braces with
180 \\[texinfo-insert-braces] and later use the command \\[up-list] to
181 move forward past the closing brace.
183 Also, Texinfo mode provides functions for automatically creating or
184 updating menus and node pointers. These functions
186 * insert the `Next', `Previous' and `Up' pointers of a node,
187 * insert or update the menu for a section, and
188 * create a master menu for a Texinfo source file.
190 Here are the functions:
192 texinfo-update-node \\[texinfo-update-node]
193 texinfo-every-node-update \\[texinfo-every-node-update]
194 texinfo-sequential-node-update
196 texinfo-make-menu \\[texinfo-make-menu]
197 texinfo-all-menus-update \\[texinfo-all-menus-update]
200 texinfo-indent-menu-description (column &optional region-p)
202 The `texinfo-column-for-description' variable specifies the column to
203 which menu descriptions are indented.
205 Passed an argument (a prefix argument, if interactive), the
206 `texinfo-update-node' and `texinfo-make-menu' functions do their jobs
209 To use the updating commands, you must structure your Texinfo file
210 hierarchically, such that each `@node' line, with the exception of the
211 Top node, is accompanied by some kind of section line, such as an
212 `@chapter' or `@section' line.
214 If the file has a `top' node, it must be called `top' or `Top' and
215 be the first node in the file.
217 Entering Texinfo mode calls the value of text-mode-hook, and then the
218 value of texinfo-mode-hook."
221 (setq mode-name "Texinfo")
222 (setq major-mode 'texinfo-mode)
223 (use-local-map texinfo-mode-map)
224 (set-syntax-table texinfo-mode-syntax-table)
225 (make-local-variable 'require-final-newline)
226 (setq require-final-newline t)
227 (make-local-variable 'page-delimiter)
228 (setq page-delimiter texinfo-chapter-level-regexp)
229 (make-local-variable 'paragraph-separate)
230 (setq paragraph-separate (concat "^\b\\|^@[a-zA-Z]*[ \n]\\|" paragraph-separate))
231 (make-local-variable 'paragraph-start)
232 (setq paragraph-start (concat "^\b\\|^@[a-zA-Z]*[ \n]\\|" paragraph-start))
233 (make-local-variable 'fill-column)
234 (setq fill-column 72)
235 (make-local-variable 'comment-start)
236 (setq comment-start "@c ")
237 (make-local-variable 'comment-start-skip)
238 (setq comment-start-skip "@c +")
239 (make-local-variable 'words-include-escapes)
240 (setq words-include-escapes t)
241 (make-local-variable 'tex-start-of-header)
242 (setq tex-start-of-header "%**start of header")
243 (make-local-variable 'tex-end-of-header)
244 (setq tex-end-of-header "%**end of header")
245 (make-local-variable 'tex-trailer)
246 (setq tex-trailer "@bye\n")
247 (run-hooks 'text-mode-hook 'texinfo-mode-hook))
250 ;;; Texinfo file structure
252 ; The following is defined in `texnfo-upd.el'
253 ; (defvar texinfo-section-types-regexp
254 ; "^@\\(chapter \\|sect\\|sub\\|unnum\\|major\\|heading \\|appendix\\)"
255 ; "Regexp matching chapter, section, other headings (but not the top node).")
257 (defun texinfo-show-structure (&optional nodes-too)
258 "Show the structure of a Texinfo file.
259 List the lines in the file that begin with the @-sign commands for
260 @chapter, @section, and the like.
262 With optional argument (prefix if interactive), list both the lines
263 with @-sign commands for @chapter, @section, and the like, and list
266 Lines with structuring commands beginning in them are displayed in
267 another window called the *Occur* window. In that window, you can
268 position the cursor over one of the lines and use
269 \\[occur-mode-goto-occurrence],
270 to jump to the corresponding spot in the Texinfo file."
274 (goto-char (point-min))
276 (occur (concat "\\(^@node\\)\\|" texinfo-section-types-regexp))
277 (occur texinfo-section-types-regexp)))
278 (pop-to-buffer "*Occur*")
279 (goto-char (point-min))
280 (flush-lines "-----"))
283 ;;; texinfo mode tex and hardcopy printing commands.
285 ;; These commands are for running tex on a region of a texinfo file in
286 ;; GNU Emacs, or on the whole buffer, and for printing the resulting
287 ;; .dvi file. The three commands are:
289 ; texinfo-tex-region to run tex on the current region.
290 ; texinfo-tex-buffer to run tex on the current buffer.
291 ; texinfo-tex-print to print the .dvi file made by tex
293 ;;; Other useful functions
295 ; These functions are provided by `tex-mode.el' but are bound to keys
298 ; tex-kill-job to kill the currently running tex job
299 ; tex-recenter-output-buffer to redisplay tex job output buffer
300 ; tex-show-print-queue to show the print queue
302 ; Various variables are provided by `tex-mode.el'
304 ; tex mode variable Default Value
306 ; tex-dvi-print-command "lpr -d"
307 ; tex-directory "/tmp/"
308 ; tex-show-queue-command "lpq"
309 ; tex-shell-cd-command "cd"
310 ; tex-zap-file nil (created as needed)
313 ;;; The tex and print function definitions:
315 (defvar texinfo-tex-command "texi2dvi"
316 "*Command used by texinfo-tex-region to run tex on a region.")
318 ;;(defvar texinfo-texindex-command "texindex"
319 ;; "*Command used by texinfo-texindex to sort unsorted index files.")
321 (defun texinfo-tex-region (beg end)
322 "Run tex on the current region.
323 A temporary file (`tex-zap-file') is written in directory `tex-directory', and
324 tex is run in that directory. The first line of the file is copied to the
325 temporary file; and if the buffer has a header, it is written to the
326 temporary file before the region itself. The buffer's header is all lines
327 between the strings defined by `tex-start-of-header' and `tex-end-of-header'
328 inclusive. The header must start in the first 100 lines. The value of
329 tex-trailer is appended to the temporary file after the region."
331 (if (get-buffer "*tex-shell*")
334 (or tex-zap-file (setq tex-zap-file (make-temp-name "#tz")))
335 (let ((tex-out-file (concat tex-zap-file ".tex"))
336 (temp-buffer (get-buffer-create " tex-Output-Buffer"))
338 (file-name-as-directory (expand-file-name tex-directory))))
342 (goto-char (point-min))
344 (let ((search-end (point))
345 (hbeg (point-min)) (hend (point-min))
346 (default-directory zap-directory))
347 (goto-char (point-min))
349 ;; Copy first line, the `\input texinfo' line, to temp file
350 (write-region (point)
351 (save-excursion (end-of-line) (point))
352 tex-out-file nil nil)
354 ;; Don't copy first line twice if region includes it.
356 (if (< beg (point)) (setq beg (point)))
358 ;; Initialize the temp file with either the header or nothing
359 (if (search-forward tex-start-of-header search-end t)
362 (setq hbeg (point)) ; Mark beginning of header.
363 (if (search-forward tex-end-of-header nil t)
364 (progn (beginning-of-line)
365 (setq hend (point))) ; Mark end of header.
366 (setq hbeg (point-min))))) ; Else no header.
368 ;; Copy header to temp file.
369 (write-region (min hbeg beg) hend tex-out-file t nil)
371 ;; Copy region to temp file.
372 (write-region (max beg hend) end tex-out-file t nil))
374 ;; This is a kludge to insert the tex-trailer into the tex-out-file.
375 ;; We have to create a special buffer in which to insert
376 ;; the tex-trailer first because there is no function with
377 ;; which to append a literal string directly to a file.
378 (let ((local-tex-trailer tex-trailer))
379 (set-buffer temp-buffer)
381 ;; make sure trailer isn't hidden by a comment
383 (if local-tex-trailer (insert-string local-tex-trailer))
384 (set-buffer-directory temp-buffer zap-directory)
385 (write-region (point-min) (point-max) tex-out-file t nil))))
387 (set-buffer-directory "*tex-shell*" zap-directory)
388 (send-string "tex-shell" (concat tex-shell-cd-command " "
390 (send-string "tex-shell" (concat texinfo-tex-command " "
392 (tex-recenter-output-buffer 0))
394 (defun texinfo-tex-buffer ()
395 "Run tex on current buffer.
396 See \\[texinfo-tex-region] for more information."
398 (texinfo-tex-region (point-min) (point-max)))
400 ;;(defun texinfo-texindex ()
401 ;; "Run texindex on unsorted index files.
402 ;;The index files are made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer].
403 ;;Runs the shell command defined by `texinfo-texindex-command'."
405 ;; (send-string "tex-shell"
406 ;; (concat texinfo-texindex-command
407 ;; " " tex-zap-file ".??" "\n"))
408 ;; (tex-recenter-output-buffer nil))
410 (defun texinfo-tex-print ()
411 "Print .dvi file made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer].
412 Runs the shell command defined by `tex-dvi-print-command'."
414 (send-string "tex-shell"
415 (concat tex-dvi-print-command
416 " " tex-zap-file ".dvi" "\n"))
417 (tex-recenter-output-buffer nil))
421 ;;; texinfo.el ends here