annotate doc/lispref/two.el @ 112419:a651b7492a78

* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine): Assume foo(bar) is a manpage reference rather than some unquoted symbol.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Fri, 21 Jan 2011 13:12:32 -0500
parents 376148b31b5e
children ef719132ddfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84108
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 ;; Auxiliary functions for preparing a two volume manual.
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 106876
diff changeset
3 ;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
84108
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4 ;; Free Software Foundation, Inc.
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 ;; --rjc 30mar92
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7
95035
fde6f792a832 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
8 ;; This file is free software: you can redistribute it and/or modify
84108
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 ;; it under the terms of the GNU General Public License as published by
95035
fde6f792a832 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
10 ;; the Free Software Foundation, either version 3 of the License, or
fde6f792a832 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
11 ;; (at your option) any later version.
84108
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 ;; This file is distributed in the hope that it will be useful,
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 ;; GNU General Public License for more details.
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 ;; You should have received a copy of the GNU General Public License
95035
fde6f792a832 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
19 ;; along with this file. If not, see <http://www.gnu.org/licenses/>.
fde6f792a832 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
20
84108
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 (defun volume-aux-markup (arg)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 "Append `vol. NUMBER' to page number.
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 Apply to aux file that you save.
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 Then insert marked file into other volume's .aux file."
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 (interactive "sType volume number, 1 or 2: " )
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 (goto-char (point-min))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 (while (search-forward "-pg" nil t)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 (end-of-line 1)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 (delete-backward-char 1 nil)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 (insert ", vol.'tie" arg "}")))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 (defun volume-index-markup (arg)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 "Prepend `NUMBER:' to page number. Use Roman Numeral.
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 Apply only to unsorted index file,
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 Then insert marked file into other volume's unsorted index file.
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 Then run texindex on that file and save."
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 (interactive
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 "sType volume number, roman number I or II: " )
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 (goto-char (point-min))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 (while (search-forward "\\entry" nil t)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 (search-forward "}{" (save-excursion (end-of-line) (point)) nil)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 (insert arg ":")))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 (defun volume-numbers-toc-markup (arg)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 (interactive
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 "sType volume number, roman number I or II: " )
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 (goto-char (point-min))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 (while (search-forward "chapentry" nil t)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 (end-of-line)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 (search-backward "{" nil t)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 (forward-char 1)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 (insert arg ":")))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 (defun volume-header-toc-markup ()
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 "Insert Volume I and Volume II text into .toc file.
106876
ad7558737bc7 Fix typos in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 106815
diff changeset
57 NOTE: this auxiliary function is file specific.
ad7558737bc7 Fix typos in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 106815
diff changeset
58 This is for the *Elisp Ref Manual*."
84108
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 (interactive)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 (goto-char (point-min))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 (insert "\\unnumbchapentry {Volume 1}{}\n\\unnumbchapentry {}{}\n")
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 (search-forward "\\unnumbchapentry {Index}")
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 (forward-line 1)
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 (insert
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 "\\unnumbchapentry {}{}\n\\unnumbchapentry {}{}\n\\unnumbchapentry {}{}\n\\unnumbchapentry {}{}\n\\unnumbchapentry {Volume 2}{}\n\\unnumbchapentry {}{}\n"))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 ;;; In batch mode, you cannot call functions with args; hence this kludge:
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 (defun volume-aux-markup-1 () (volume-aux-markup "1"))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 (defun volume-aux-markup-2 () (volume-aux-markup "2"))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 (defun volume-index-markup-I () (volume-index-markup "I"))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 (defun volume-index-markup-II () (volume-index-markup "II"))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 (defun volume-numbers-toc-markup-I () (volume-numbers-toc-markup "I"))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 (defun volume-numbers-toc-markup-II () (volume-numbers-toc-markup "II"))
b0561f19a8b5 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78
95035
fde6f792a832 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
79 ;; arch-tag: 848955fe-e9cf-45e7-a2f1-570ef156d6a5
fde6f792a832 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
80 ;;; two.el ends here