Mercurial > emacs
annotate lisp/textmodes/texnfo-upd.el @ 103508:b3c1a923f213
* xdisp.c (Qbefore_string, Qafter_string): Add externs.
(load_overlay_strings): Remove externs.
(fast_find_position): Function deleted.
(mouse_face_from_buffer_pos): New function, based on
fast_find_position. Correctly handle before-strings,
display-strings, and after-strings (Bug#1220).
(note_mouse_highlight): Use mouse_face_from_buffer_pos.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Mon, 22 Jun 2009 01:53:11 +0000 |
parents | a9dc0e7c3f2b |
children | df4934f25eef |
rev | line source |
---|---|
13337 | 1 ;;; texnfo-upd.el --- utilities for updating nodes and menus in Texinfo files |
13354 | 2 |
64751
5b1a238fcbb4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64084
diff
changeset
|
3 ;; Copyright (C) 1989, 1990, 1991, 1992, 2001, 2002, 2003, 2004, |
100908 | 4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
107 | 5 |
19110 | 6 ;; Author: Robert J. Chassell |
43808 | 7 ;; Maintainer: bug-texinfo@gnu.org |
814
38b2499cb3e9
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
775
diff
changeset
|
8 ;; Keywords: maint, tex, docs |
107 | 9 |
10 ;; This file is part of GNU Emacs. | |
11 | |
94670
f4a69fedbd46
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
12 ;; GNU Emacs is free software: you can redistribute it and/or modify |
107 | 13 ;; it under the terms of the GNU General Public License as published by |
94670
f4a69fedbd46
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
14 ;; the Free Software Foundation, either version 3 of the License, or |
f4a69fedbd46
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
15 ;; (at your option) any later version. |
107 | 16 |
17 ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 ;; GNU General Public License for more details. | |
21 | |
22 ;; You should have received a copy of the GNU General Public License | |
94670
f4a69fedbd46
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
107 | 24 |
775
1ca26ccad38e
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
732
diff
changeset
|
25 ;;; Commentary: |
107 | 26 |
14169 | 27 ;; Known bug: update commands fail to ignore @ignore. |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
28 |
14169 | 29 ;; Summary: how to use the updating commands |
107 | 30 |
14169 | 31 ;; The node and menu updating functions automatically |
107 | 32 |
14169 | 33 ;; * insert missing `@node' lines, |
34 ;; * insert the `Next', `Previous' and `Up' pointers of a node, | |
19110 | 35 ;; * insert or update the menu for a section, |
14169 | 36 ;; * create a master menu for a Texinfo source file. |
37 ;; | |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
38 ;; With a prefix argument, the `texinfo-update-node' and |
14169 | 39 ;; `texinfo-make-menu' functions do their jobs in the region. |
40 ;; | |
41 ;; In brief, the functions for creating or updating nodes and menus, are: | |
19110 | 42 ;; |
43 ;; texinfo-update-node (&optional beginning end) | |
44 ;; texinfo-every-node-update () | |
14169 | 45 ;; texinfo-sequential-node-update (&optional region-p) |
19110 | 46 ;; |
47 ;; texinfo-make-menu (&optional beginning end) | |
48 ;; texinfo-all-menus-update () | |
14169 | 49 ;; texinfo-master-menu () |
50 ;; | |
51 ;; texinfo-insert-node-lines (&optional title-p) | |
19110 | 52 ;; |
14169 | 53 ;; texinfo-indent-menu-description (column &optional region-p) |
107 | 54 |
14169 | 55 ;; The `texinfo-column-for-description' variable specifies the column to |
19110 | 56 ;; which menu descriptions are indented. |
107 | 57 |
14169 | 58 ;; Texinfo file structure |
59 ;; ---------------------- | |
107 | 60 |
14169 | 61 ;; To use the updating commands, you must structure your Texinfo file |
62 ;; hierarchically. Each `@node' line, with the exception of the top | |
63 ;; node, must be accompanied by some kind of section line, such as an | |
64 ;; `@chapter' or `@section' line. Each node-line/section-line | |
65 ;; combination must look like this: | |
107 | 66 |
14169 | 67 ;; @node Lists and Tables, Cross References, Structuring, Top |
68 ;; @comment node-name, next, previous, up | |
69 ;; @chapter Making Lists and Tables | |
107 | 70 |
14169 | 71 ;; or like this (without the `@comment' line): |
107 | 72 |
14169 | 73 ;; @node Lists and Tables, Cross References, Structuring, Top |
74 ;; @chapter Making Lists and Tables | |
107 | 75 |
14169 | 76 ;; If the file has a `top' node, it must be called `top' or `Top' and |
77 ;; be the first node in the file. | |
107 | 78 |
79 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
80 ;;; The update node functions described in detail |
107 | 81 |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
82 ;; The `texinfo-update-node' command with no prefix argument inserts |
14169 | 83 ;; the correct next, previous and up pointers for the node in which |
84 ;; point is located (i.e., for the node preceding point). | |
107 | 85 |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
86 ;; With prefix argument, the `texinfo-update-node' function inserts the |
14169 | 87 ;; correct next, previous and up pointers for the nodes inside the |
88 ;; region. | |
107 | 89 |
14169 | 90 ;; It does not matter whether the `@node' line has pre-existing |
91 ;; `Next', `Previous', or `Up' pointers in it. They are removed. | |
107 | 92 |
14169 | 93 ;; The `texinfo-every-node-update' function runs `texinfo-update-node' |
94 ;; on the whole buffer. | |
107 | 95 |
14169 | 96 ;; The `texinfo-sequential-node-update' function inserts the |
97 ;; immediately following and preceding node into the `Next' or | |
98 ;; `Previous' pointers regardless of their hierarchical level. This is | |
99 ;; only useful for certain kinds of text, like a novel, which you go | |
100 ;; through sequentially. | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
101 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
102 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
103 ;;; The menu making functions described in detail |
107 | 104 |
14169 | 105 ;; The `texinfo-make-menu' function without an argument creates or |
106 ;; updates a menu for the section encompassing the node that follows | |
107 ;; point. With an argument, it makes or updates menus for the nodes | |
108 ;; within or part of the marked region. | |
107 | 109 |
14169 | 110 ;; Whenever an existing menu is updated, the descriptions from |
111 ;; that menu are incorporated into the new menu. This is done by copying | |
112 ;; descriptions from the existing menu to the entries in the new menu | |
113 ;; that have the same node names. If the node names are different, the | |
114 ;; descriptions are not copied to the new menu. | |
107 | 115 |
14169 | 116 ;; Menu entries that refer to other Info files are removed since they |
117 ;; are not a node within current buffer. This is a deficiency. | |
107 | 118 |
14169 | 119 ;; The `texinfo-all-menus-update' function runs `texinfo-make-menu' |
120 ;; on the whole buffer. | |
107 | 121 |
14169 | 122 ;; The `texinfo-master-menu' function creates an extended menu located |
123 ;; after the top node. (The file must have a top node.) The function | |
124 ;; first updates all the regular menus in the buffer (incorporating the | |
125 ;; descriptions from pre-existing menus), and then constructs a master | |
126 ;; menu that includes every entry from every other menu. (However, the | |
127 ;; function cannot update an already existing master menu; if one | |
128 ;; exists, it must be removed before calling the function.) | |
107 | 129 |
14169 | 130 ;; The `texinfo-indent-menu-description' function indents every |
131 ;; description in the menu following point, to the specified column. | |
132 ;; Non-nil argument (prefix, if interactive) means indent every | |
133 ;; description in every menu in the region. This function does not | |
134 ;; indent second and subsequent lines of a multi-line description. | |
107 | 135 |
14169 | 136 ;; The `texinfo-insert-node-lines' function inserts `@node' before the |
137 ;; `@chapter', `@section', and such like lines of a region in a Texinfo | |
138 ;; file where the `@node' lines are missing. | |
19110 | 139 ;; |
14169 | 140 ;; With a non-nil argument (prefix, if interactive), the function not |
141 ;; only inserts `@node' lines but also inserts the chapter or section | |
142 ;; titles as the names of the corresponding nodes; and inserts titles | |
143 ;; as node names in pre-existing `@node' lines that lack names. | |
19110 | 144 ;; |
14169 | 145 ;; Since node names should be more concise than section or chapter |
146 ;; titles, node names so inserted will need to be edited manually. | |
107 | 147 |
19110 | 148 |
775
1ca26ccad38e
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
732
diff
changeset
|
149 ;;; Code: |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
150 |
33258
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
151 (require 'texinfo) |
19630
95743e18a01c
(defgroup, defcustom): Add Emacs 19 compatibility definitions.
Richard M. Stallman <rms@gnu.org>
parents:
19110
diff
changeset
|
152 |
95743e18a01c
(defgroup, defcustom): Add Emacs 19 compatibility definitions.
Richard M. Stallman <rms@gnu.org>
parents:
19110
diff
changeset
|
153 |
18849
b4b2ad407ba0
(texinfo-all-menus-update)
Richard M. Stallman <rms@gnu.org>
parents:
18259
diff
changeset
|
154 (defvar texinfo-master-menu-header |
b4b2ad407ba0
(texinfo-all-menus-update)
Richard M. Stallman <rms@gnu.org>
parents:
18259
diff
changeset
|
155 " --- The Detailed Node Listing ---\n" |
b4b2ad407ba0
(texinfo-all-menus-update)
Richard M. Stallman <rms@gnu.org>
parents:
18259
diff
changeset
|
156 "String inserted before lower level entries in Texinfo master menu. |
b4b2ad407ba0
(texinfo-all-menus-update)
Richard M. Stallman <rms@gnu.org>
parents:
18259
diff
changeset
|
157 It comes after the chapter-level menu entries.") |
b4b2ad407ba0
(texinfo-all-menus-update)
Richard M. Stallman <rms@gnu.org>
parents:
18259
diff
changeset
|
158 |
40284
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
159 ;; We used to look for just sub, but that found @subtitle. |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
160 (defvar texinfo-section-types-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
161 "^@\\(chapter \\|sect\\|subs\\|subh\\|unnum\\|major\\|chapheading \\|heading \\|appendix\\)" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
162 "Regexp matching chapter, section, other headings (but not the top node).") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
163 |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
164 (defvar texinfo-section-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
165 (regexp-opt (texinfo-filter 3 texinfo-section-list)) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
166 "Regular expression matching just the Texinfo section level headings.") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
167 |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
168 (defvar texinfo-subsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
169 (regexp-opt (texinfo-filter 4 texinfo-section-list)) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
170 "Regular expression matching just the Texinfo subsection level headings.") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
171 |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
172 (defvar texinfo-subsubsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
173 (regexp-opt (texinfo-filter 5 texinfo-section-list)) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
174 "Regular expression matching just the Texinfo subsubsection level headings.") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
175 |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
176 (defvar texinfo-update-menu-same-level-regexps |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
177 '((1 . "top[ \t]+") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
178 (2 . (concat "\\(^@\\)\\(" texinfo-chapter-level-regexp "\\)\\>[ \t]*")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
179 (3 . (concat "\\(^@\\)\\(" texinfo-section-level-regexp "\\)\\>[ \t]*")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
180 (4 . (concat "\\(^@\\)\\(" texinfo-subsection-level-regexp "\\)\\>[ \t]+")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
181 (5 . (concat "\\(^@\\)\\(" texinfo-subsubsection-level-regexp "\\)\\>[ \t]+"))) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
182 "*Regexps for searching for same level sections in a Texinfo file. |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
183 The keys are strings specifying the general hierarchical level in the |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
184 document; the values are regular expressions.") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
185 |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
186 (defvar texinfo-update-menu-higher-regexps |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
187 '((1 . "^@node [ \t]*DIR") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
188 (2 . "^@node [ \t]*top[ \t]*\\(,\\|$\\)") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
189 (3 . |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
190 (concat |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
191 "\\(^@\\(" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
192 texinfo-chapter-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
193 "\\)\\>[ \t]*\\)")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
194 (4 . |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
195 (concat |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
196 "\\(^@\\(" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
197 texinfo-section-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
198 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
199 texinfo-chapter-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
200 "\\)\\>[ \t]*\\)")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
201 (5 . |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
202 (concat |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
203 "\\(^@\\(" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
204 texinfo-subsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
205 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
206 texinfo-section-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
207 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
208 texinfo-chapter-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
209 "\\)\\>[ \t]*\\)"))) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
210 "*Regexps for searching for higher level sections in a Texinfo file. |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
211 The keys are strings specifying the general hierarchical level in the |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
212 document; the values are regular expressions.") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
213 |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
214 (defvar texinfo-update-menu-lower-regexps |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
215 '((1 . |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
216 (concat |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
217 "\\(^@\\(" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
218 texinfo-chapter-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
219 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
220 texinfo-section-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
221 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
222 texinfo-subsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
223 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
224 texinfo-subsubsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
225 "\\)\\>[ \t]*\\)")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
226 (2 . |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
227 (concat |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
228 "\\(^@\\(" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
229 texinfo-section-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
230 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
231 texinfo-subsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
232 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
233 texinfo-subsubsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
234 "\\)\\>[ \t]*\\)")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
235 (3 . |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
236 (concat |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
237 "\\(^@\\(" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
238 texinfo-subsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
239 "\\|" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
240 texinfo-subsubsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
241 "\\)\\>[ \t]+\\)")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
242 (4 . |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
243 (concat |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
244 "\\(^@\\(" |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
245 texinfo-subsubsection-level-regexp |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
246 "\\)\\>[ \t]+\\)")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
247 ;; There's nothing below 5, use a bogus regexp that can't match. |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
248 (5 . "a\\(^\\)")) |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
249 "*Regexps for searching for lower level sections in a Texinfo file. |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
250 The keys are strings specifying the general hierarchical level in the |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
251 document; the values are regular expressions.") |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
252 |
1b45ff920a8c
(texinfo-section-types-regexp)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38963
diff
changeset
|
253 |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
254 (defun texinfo-make-menu (&optional beginning end) |
107 | 255 "Without any prefix argument, make or update a menu. |
256 Make the menu for the section enclosing the node found following point. | |
257 | |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
258 A prefix argument means make or update menus |
107 | 259 for nodes within or part of the marked region. |
260 | |
261 Whenever a menu exists, and is being updated, the descriptions that | |
262 are associated with node names in the pre-existing menu are | |
43430
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
263 incorporated into the new menu. |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
264 |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
265 Leaves trailing whitespace in a menu that lacks descriptions, so |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
266 descriptions will format well. In general, a menu should contain |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
267 descriptions, because node names and section titles are often too |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
268 short to explain a node well." |
19110 | 269 |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
270 (interactive |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
271 (if prefix-arg |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
272 (list (point) (mark)))) |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
273 (if (null beginning) |
107 | 274 (let ((level (texinfo-hierarchic-level))) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
275 (texinfo-make-one-menu level) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
276 (message "Menu updated")) |
107 | 277 ;; else |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
278 (message "Making or updating menus in %s... " (buffer-name)) |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
279 (save-excursion |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
280 (goto-char (min beginning end)) |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
281 ;; find section type following point |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
282 (let ((level (texinfo-hierarchic-level)) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
283 (region-end-marker (make-marker))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
284 (set-marker region-end-marker (max beginning end)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
285 (save-restriction |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
286 (widen) |
19110 | 287 |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
288 (while (texinfo-find-lower-level-node |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
289 level (marker-position region-end-marker)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
290 (setq level (texinfo-hierarchic-level)) ; new, lower level |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
291 (texinfo-make-one-menu level)) |
19110 | 292 |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
293 (while (and (< (point) (marker-position region-end-marker)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
294 (texinfo-find-higher-level-node |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
295 level (marker-position region-end-marker))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
296 (setq level (texinfo-hierarchic-level)) |
23414
c9d093e48f15
(texinfo-make-menu): Don't let
Richard M. Stallman <rms@gnu.org>
parents:
22396
diff
changeset
|
297 ;; Don't allow texinfo-find-higher-level-node |
c9d093e48f15
(texinfo-make-menu): Don't let
Richard M. Stallman <rms@gnu.org>
parents:
22396
diff
changeset
|
298 ;; to find the same node again. |
c9d093e48f15
(texinfo-make-menu): Don't let
Richard M. Stallman <rms@gnu.org>
parents:
22396
diff
changeset
|
299 (forward-line 1) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
300 (while (texinfo-find-lower-level-node |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
301 level (marker-position region-end-marker)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
302 (setq level (texinfo-hierarchic-level)) ; new, lower level |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
303 (texinfo-make-one-menu level)))))) |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
304 (message "Making or updating menus in %s...done" (buffer-name)))) |
107 | 305 |
306 (defun texinfo-make-one-menu (level) | |
307 "Make a menu of all the appropriate nodes in this section. | |
19110 | 308 `Appropriate nodes' are those associated with sections that are |
107 | 309 at the level specified by LEVEL. Point is left at the end of menu." |
310 (let* | |
311 ((case-fold-search t) | |
143 | 312 (beginning |
313 (save-excursion | |
314 (goto-char (texinfo-update-menu-region-beginning level)) | |
315 (end-of-line) | |
316 (point))) | |
107 | 317 (end (texinfo-update-menu-region-end level)) |
318 (first (texinfo-menu-first-node beginning end)) | |
319 (node-name (progn | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
320 (goto-char beginning) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
321 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
322 (texinfo-copy-node-name))) |
107 | 323 (new-menu-list (texinfo-make-menu-list beginning end level))) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
324 (when (texinfo-old-menu-p beginning first) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
325 (texinfo-incorporate-descriptions new-menu-list) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
326 (texinfo-incorporate-menu-entry-names new-menu-list) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
327 (texinfo-delete-old-menu beginning first)) |
107 | 328 (texinfo-insert-menu new-menu-list node-name))) |
329 | |
330 (defun texinfo-all-menus-update (&optional update-all-nodes-p) | |
331 "Update every regular menu in a Texinfo file. | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
332 Update pre-existing master menu, if there is one. |
107 | 333 |
334 If called with a non-nil argument, this function first updates all the | |
43430
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
335 nodes in the buffer before updating the menus. |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
336 |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
337 Indents the first line of descriptions, and leaves trailing whitespace |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
338 in a menu that lacks descriptions, so descriptions will format well. |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
339 In general, a menu should contain descriptions, because node names and |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
340 section titles are often too short to explain a node well." |
107 | 341 (interactive "P") |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
342 (let ((case-fold-search t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
343 master-menu-p) |
107 | 344 (save-excursion |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
345 (push-mark (point-max) t) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
346 (goto-char (point-min)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
347 (message "Checking for a master menu in %s ... "(buffer-name)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
348 (save-excursion |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
349 (when (search-forward texinfo-master-menu-header nil t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
350 ;; Check if @detailmenu kludge is used; |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
351 ;; if so, leave point before @detailmenu. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
352 (search-backward "\n@detailmenu" |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
353 (save-excursion (forward-line -3) (point)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
354 t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
355 ;; Remove detailed master menu listing |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
356 (setq master-menu-p t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
357 (goto-char (match-beginning 0)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
358 (let ((end-of-detailed-menu-descriptions |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
359 (save-excursion ; beginning of end menu line |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
360 (goto-char (texinfo-menu-end)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
361 (beginning-of-line) (forward-char -1) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
362 (point)))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
363 (delete-region (point) end-of-detailed-menu-descriptions)))) |
19110 | 364 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
365 (when update-all-nodes-p |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
366 (message "Updating all nodes in %s ... " (buffer-name)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
367 (texinfo-update-node (point-min) (point-max))) |
19110 | 368 |
369 (message "Updating all menus in %s ... " (buffer-name)) | |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
370 (texinfo-make-menu (point-max) (point-min)) |
19110 | 371 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
372 (when master-menu-p |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
373 (message "Updating the master menu in %s... " (buffer-name)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
374 (texinfo-master-menu nil))) |
19110 | 375 |
107 | 376 (message "Done...updated all the menus. You may save the buffer."))) |
377 | |
378 (defun texinfo-find-lower-level-node (level region-end) | |
379 "Search forward from point for node at any level lower than LEVEL. | |
19110 | 380 Search is limited to the end of the marked region, REGION-END, |
107 | 381 and to the end of the menu region for the level. |
382 | |
383 Return t if the node is found, else nil. Leave point at the beginning | |
384 of the node if one is found; else do not move point." | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
385 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
386 (if (and (< (point) region-end) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
387 (re-search-forward |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
388 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
389 "\\(^@node\\).*\n" ; match node line |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
390 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
391 "\\|" ; or |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
392 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
393 "\\|" ; or |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
394 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
395 "\\)?" ; end of expression |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
396 (eval (cdr (assoc level texinfo-update-menu-lower-regexps)))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
397 ;; the next higher level node marks the end of this |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
398 ;; section, and no lower level node will be found beyond |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
399 ;; this position even if region-end is farther off |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
400 (texinfo-update-menu-region-end level) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
401 t)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
402 (goto-char (match-beginning 1))))) |
107 | 403 |
404 (defun texinfo-find-higher-level-node (level region-end) | |
405 "Search forward from point for node at any higher level than argument LEVEL. | |
406 Search is limited to the end of the marked region, REGION-END. | |
407 | |
408 Return t if the node is found, else nil. Leave point at the beginning | |
23414
c9d093e48f15
(texinfo-make-menu): Don't let
Richard M. Stallman <rms@gnu.org>
parents:
22396
diff
changeset
|
409 of the node if one is found; else do not move point. |
c9d093e48f15
(texinfo-make-menu): Don't let
Richard M. Stallman <rms@gnu.org>
parents:
22396
diff
changeset
|
410 |
c9d093e48f15
(texinfo-make-menu): Don't let
Richard M. Stallman <rms@gnu.org>
parents:
22396
diff
changeset
|
411 A `@node' line starting at point does count as a match; |
c9d093e48f15
(texinfo-make-menu): Don't let
Richard M. Stallman <rms@gnu.org>
parents:
22396
diff
changeset
|
412 if the match is found there, the value is t and point does not move." |
c9d093e48f15
(texinfo-make-menu): Don't let
Richard M. Stallman <rms@gnu.org>
parents:
22396
diff
changeset
|
413 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
414 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
415 (cond |
33258
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
416 ((< level 3) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
417 (if (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" region-end t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
418 (progn (beginning-of-line) t))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
419 (t |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
420 (when (re-search-forward |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
421 (concat |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
422 "\\(^@node\\).*\n" ; match node line |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
423 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
424 "\\|" ; or |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
425 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
426 "\\|" ; or |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
427 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
428 "\\)?" ; end of expression |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
429 (eval (cdr (assoc level texinfo-update-menu-higher-regexps)))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
430 region-end t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
431 (beginning-of-line) t))))) |
107 | 432 |
433 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
434 ;;; Making the list of new menu entries |
107 | 435 |
436 (defun texinfo-make-menu-list (beginning end level) | |
437 "Make a list of node names and their descriptions. | |
438 Point is left at the end of the menu region, but the menu is not inserted. | |
439 | |
19110 | 440 First argument is position from which to start making menu list; |
107 | 441 second argument is end of region in which to try to locate entries; |
442 third argument is the level of the nodes that are the entries. | |
443 | |
444 Node names and descriptions are dotted pairs of strings. Each pair is | |
445 an element of the list. If the description does not exist, the | |
446 element consists only of the node name." | |
447 (goto-char beginning) | |
448 (let (new-menu-list) | |
449 (while (texinfo-menu-locate-entry-p level end) | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
450 (push (cons |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
451 (texinfo-copy-node-name) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
452 (prog1 "" (forward-line 1))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
453 ;; Use following to insert section titles automatically. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
454 ;; (texinfo-copy-section-title)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
455 new-menu-list)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
456 (nreverse new-menu-list))) |
107 | 457 |
458 (defun texinfo-menu-locate-entry-p (level search-end) | |
459 "Find a node that will be part of menu for this section. | |
460 First argument is a string such as \"section\" specifying the general | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
461 hierarchical level of the menu; second argument is a position |
107 | 462 specifying the end of the search. |
463 | |
464 The function returns t if the node is found, else nil. It searches | |
465 forward from point, and leaves point at the beginning of the node. | |
466 | |
467 The function finds entries of the same type. Thus `subsections' and | |
468 `unnumberedsubsecs' will appear in the same menu." | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
469 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
470 (if (re-search-forward |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
471 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
472 "\\(^@node\\).*\n" ; match node line |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
473 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
474 "\\|" ; or |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
475 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
476 "\\|" ; or |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
477 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
478 "\\)?" ; end of expression |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
479 (eval |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
480 (cdr (assoc level texinfo-update-menu-same-level-regexps)))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
481 search-end |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
482 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
483 (goto-char (match-beginning 1))))) |
107 | 484 |
485 (defun texinfo-copy-node-name () | |
486 "Return the node name as a string. | |
487 | |
488 Start with point at the beginning of the node line; copy the text | |
489 after the node command up to the first comma on the line, if any, and | |
490 return the text as a string. Leaves point at the beginning of the | |
491 line. If there is no node name, returns an empty string." | |
19110 | 492 |
107 | 493 (save-excursion |
494 (buffer-substring | |
495 (progn (forward-word 1) ; skip over node command | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
496 (skip-chars-forward " \t") ; and over spaces |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
497 (point)) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
498 (if (search-forward "," (line-end-position) t) ; bound search |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
499 (1- (point)) |
107 | 500 (end-of-line) (point))))) |
501 | |
502 (defun texinfo-copy-section-title () | |
503 "Return the title of the section as a string. | |
504 The title is used as a description line in the menu when one does not | |
505 already exist. | |
506 | |
507 Move point to the beginning of the appropriate section line by going | |
508 to the start of the text matched by last regexp searched for, which | |
509 must have been done by `texinfo-menu-locate-entry-p'." | |
510 | |
511 ;; could use the same re-search as in `texinfo-menu-locate-entry-p' | |
512 ;; instead of using `match-beginning'; such a variation would be | |
513 ;; more general, but would waste information already collected | |
514 | |
19110 | 515 (goto-char (match-beginning 7)) ; match section name |
107 | 516 |
517 (buffer-substring | |
518 (progn (forward-word 1) ; skip over section type | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
519 (skip-chars-forward " \t") ; and over spaces |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
520 (point)) |
107 | 521 (progn (end-of-line) (point)))) |
522 | |
523 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
524 ;;; Handling the old menu |
107 | 525 |
526 (defun texinfo-old-menu-p (beginning first) | |
527 "Move point to the beginning of the menu for this section, if any. | |
528 Otherwise move point to the end of the first node of this section. | |
529 Return t if a menu is found, nil otherwise. | |
530 | |
531 First argument is the position of the beginning of the section in which | |
532 the menu will be located; second argument is the position of the first | |
533 node within the section. | |
534 | |
535 If no menu is found, the function inserts two newlines just before the | |
536 end of the section, and leaves point there where a menu ought to be." | |
537 (goto-char beginning) | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
538 (if (re-search-forward "^@menu" first 'goto-end) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
539 t |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
540 (insert "\n\n") (forward-line -2) nil)) |
107 | 541 |
542 (defun texinfo-incorporate-descriptions (new-menu-list) | |
543 "Copy the old menu line descriptions that exist to the new menu. | |
544 | |
545 Point must be at beginning of old menu. | |
546 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
547 If the node-name of the new menu is found in the old menu, insert the |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
548 old description into the new entry. |
107 | 549 |
550 For this function, the new menu is a list made up of lists of dotted | |
551 pairs in which the first element of the pair is the node name and the | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
552 second element the description. The new menu is changed destructively. |
18259 | 553 The old menu is the menu as it appears in the Texinfo file." |
19110 | 554 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
555 (let ((end-of-menu (texinfo-menu-end))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
556 (dolist (new-menu new-menu-list new-menu-list) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
557 (save-excursion ; keep point at beginning of menu |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
558 (when (re-search-forward |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
559 ;; Existing nodes can have the form |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
560 ;; * NODE NAME:: DESCRIPTION |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
561 ;; or |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
562 ;; * MENU ITEM: NODE NAME. DESCRIPTION. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
563 ;; |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
564 ;; Recognize both when looking for the description. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
565 (concat "\\* \\(" ; so only menu entries are found |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
566 (regexp-quote (car new-menu)) "::" |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
567 "\\|" |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
568 ".*: " (regexp-quote (car new-menu)) "[.,\t\n]" |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
569 "\\)" |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
570 ) ; so only complete entries are found |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
571 end-of-menu |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
572 t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
573 (setcdr new-menu (texinfo-menu-copy-old-description end-of-menu))))))) |
107 | 574 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
575 (defun texinfo-incorporate-menu-entry-names (new-menu-list) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
576 "Copy any old menu entry names to the new menu. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
577 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
578 Point must be at beginning of old menu. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
579 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
580 If the node-name of the new menu entry cannot be found in the old |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
581 menu, do nothing. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
582 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
583 For this function, the new menu is a list made up of lists of dotted |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
584 pairs in which the first element of the pair is the node name and the |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
585 second element is the description (or nil). |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
586 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
587 If we find an existing menu entry name, we change the first element of |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
588 the pair to be another dotted pair in which the car is the menu entry |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
589 name and the cdr is the node name. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
590 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
591 NEW-MENU-LIST is changed destructively. The old menu is the menu as it |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
592 appears in the texinfo file." |
19110 | 593 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
594 (let ((end-of-menu (texinfo-menu-end))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
595 (dolist (new-menu new-menu-list new-menu-list) |
19110 | 596 (save-excursion ; keep point at beginning of menu |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
597 (if (re-search-forward |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
598 ;; Existing nodes can have the form |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
599 ;; * NODE NAME:: DESCRIPTION |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
600 ;; or |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
601 ;; * MENU ITEM: NODE NAME. DESCRIPTION. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
602 ;; |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
603 ;; We're interested in the second case. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
604 (concat "\\* " ; so only menu entries are found |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
605 "\\(.*\\): " (regexp-quote (car new-menu)) |
21180
921bd225796e
(texinfo-incorporate-menu-entry-names)
Karl Heuer <kwzh@gnu.org>
parents:
19630
diff
changeset
|
606 "[.,\t\n]") |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
607 end-of-menu |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
608 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
609 (setcar |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
610 new-menu ; replace the node name |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
611 (cons (buffer-substring (match-beginning 1) (match-end 1)) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
612 (car new-menu)))))))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
613 |
107 | 614 (defun texinfo-menu-copy-old-description (end-of-menu) |
615 "Return description field of old menu line as string. | |
616 Point must be located just after the node name. Point left before description. | |
617 Single argument, END-OF-MENU, is position limiting search." | |
618 (skip-chars-forward "[:.,\t\n ]+") | |
619 ;; don't copy a carriage return at line beginning with asterisk! | |
75627
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
620 ;; don't copy @detailmenu or @end menu or @ignore as descriptions! |
107 | 621 ;; do copy a description that begins with an `@'! |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
622 ;; !! Known bug: does not copy descriptions starting with ^|\{?* etc. |
19110 | 623 (if (and (looking-at "\\(\\w+\\|@\\)") |
75627
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
624 (not (looking-at |
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
625 "\\(^\\* \\|^@detailmenu\\|^@end menu\\|^@ignore\\)"))) |
107 | 626 (buffer-substring |
627 (point) | |
628 (save-excursion | |
75627
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
629 (re-search-forward "\\(^\\* \\|^@ignore\\|^@end menu\\)" end-of-menu t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
630 (forward-line -1) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
631 (end-of-line) ; go to end of last description line |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
632 (point))) |
107 | 633 "")) |
634 | |
635 (defun texinfo-menu-end () | |
18259 | 636 "Return position of end of menu, but don't move point. |
107 | 637 Signal an error if not end of menu." |
638 (save-excursion | |
639 (if (re-search-forward "^@end menu" nil t) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
640 (point) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
641 (error "Menu does not have an end")))) |
107 | 642 |
643 (defun texinfo-delete-old-menu (beginning first) | |
644 "Delete the old menu. Point must be in or after menu. | |
645 First argument is position of the beginning of the section in which | |
646 the menu will be located; second argument is the position of the first | |
647 node within the section." | |
648 ;; No third arg to search, so error if search fails. | |
649 (re-search-backward "^@menu" beginning) | |
650 (delete-region (point) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
651 (save-excursion |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
652 (re-search-forward "^@end menu" first) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
653 (point)))) |
107 | 654 |
655 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
656 ;;; Inserting new menu |
107 | 657 |
658 ;; try 32, but perhaps 24 is better | |
659 (defvar texinfo-column-for-description 32 | |
660 "*Column at which descriptions start in a Texinfo menu.") | |
661 | |
662 (defun texinfo-insert-menu (menu-list node-name) | |
663 "Insert formatted menu at point. | |
43430
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
664 Indents the first line of descriptions, if any, to the value of |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
665 texinfo-column-for-description. Indenting leaves trailing whitespace |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
666 in a menu that lacks descriptions, so descriptions will format well. |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
667 In general, a menu should contain descriptions, because node names and |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
668 section titles are often too short to explain a node well. |
107 | 669 |
670 MENU-LIST has form: | |
671 | |
19110 | 672 \(\(\"node-name1\" . \"description\"\) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
673 \(\"node-name2\" . \"description\"\) ... \) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
674 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
675 However, the description field might be nil. |
107 | 676 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
677 Also, the node-name field might itself be a dotted pair (call it P) of |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
678 strings instead of just a string. In that case, the car of P |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
679 is the menu entry name, and the cdr of P is the node name." |
19110 | 680 |
107 | 681 (insert "@menu\n") |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
682 (dolist (menu menu-list) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
683 ;; Every menu entry starts with a star and a space. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
684 (insert "* ") |
19110 | 685 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
686 ;; Insert the node name (and menu entry name, if present). |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
687 (let ((node-part (car menu))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
688 (if (stringp node-part) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
689 ;; "Double colon" entry line; menu entry and node name are the same, |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
690 (insert (format "%s::" node-part)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
691 ;; "Single colon" entry line; menu entry and node name are different. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
692 (insert (format "%s: %s." (car node-part) (cdr node-part))))) |
19110 | 693 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
694 ;; Insert the description, if present. |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
695 (when (cdr menu) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
696 ;; Move to right place. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
697 (indent-to texinfo-column-for-description 2) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
698 ;; Insert description. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
699 (insert (format "%s" (cdr menu)))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
700 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
701 (insert "\n")) ; end this menu entry |
107 | 702 (insert "@end menu") |
43660
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
703 (let ((level (texinfo-hierarchic-level))) |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
704 (message |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
705 "Updated level \"%s\" menu following node: %s ... " level node-name))) |
107 | 706 |
707 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
708 ;;; Starting menu descriptions by inserting titles |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
709 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
710 (defun texinfo-start-menu-description () |
19110 | 711 "In this menu entry, insert the node's section title as a description. |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
712 Position point at beginning of description ready for editing. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
713 Do not insert a title if the line contains an existing description. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
714 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
715 You will need to edit the inserted text since a useful description |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
716 complements the node name rather than repeats it as a title does." |
19110 | 717 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
718 (interactive) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
719 (let (beginning end node-name title) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
720 (save-excursion |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
721 (beginning-of-line) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
722 (if (search-forward "* " (save-excursion (end-of-line) (point)) t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
723 (progn (skip-chars-forward " \t") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
724 (setq beginning (point))) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
725 (error "This is not a line in a menu")) |
19110 | 726 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
727 (cond |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
728 ;; "Double colon" entry line; menu entry and node name are the same, |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
729 ((search-forward "::" (save-excursion (end-of-line) (point)) t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
730 (if (looking-at "[ \t]*[^ \t\n]+") |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
731 (error "Descriptive text already exists")) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
732 (skip-chars-backward ": \t") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
733 (setq node-name (buffer-substring beginning (point)))) |
19110 | 734 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
735 ;; "Single colon" entry line; menu entry and node name are different. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
736 ((search-forward ":" (save-excursion (end-of-line) (point)) t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
737 (skip-chars-forward " \t") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
738 (setq beginning (point)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
739 ;; Menu entry line ends in a period, comma, or tab. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
740 (if (re-search-forward "[.,\t]" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
741 (save-excursion (forward-line 1) (point)) t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
742 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
743 (if (looking-at "[ \t]*[^ \t\n]+") |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
744 (error "Descriptive text already exists")) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
745 (skip-chars-backward "., \t") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
746 (setq node-name (buffer-substring beginning (point)))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
747 ;; Menu entry line ends in a return. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
748 (re-search-forward ".*\n" |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
749 (save-excursion (forward-line 1) (point)) t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
750 (skip-chars-backward " \t\n") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
751 (setq node-name (buffer-substring beginning (point))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
752 (if (= 0 (length node-name)) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
753 (error "No node name on this line") |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
754 (insert ".")))) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
755 (t (error "No node name on this line"))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
756 ;; Search for node that matches node name, and copy the section title. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
757 (if (re-search-forward |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
758 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
759 "^@node[ \t]+" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
760 (regexp-quote node-name) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
761 ".*\n" ; match node line |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
762 "\\(" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
763 "\\(\\(^@c \\|^@comment\\).*\n\\)" ; match comment line, if any |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
764 "\\|" ; or |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
765 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
766 "\\|" ; or |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
767 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
768 "\\)?" ; end of expression |
43612
15a51e54d11d
(texinfo-start-menu-description): Remove extra paren in regexp.
Andreas Schwab <schwab@suse.de>
parents:
43430
diff
changeset
|
769 ) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
770 nil t) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
771 (setq title |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
772 (buffer-substring |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
773 ;; skip over section type |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
774 (progn (forward-word 1) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
775 ;; and over spaces |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
776 (skip-chars-forward " \t") |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
777 (point)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
778 (progn (end-of-line) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
779 (skip-chars-backward " \t") |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
780 (point)))) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
781 (error "Cannot find node to match node name in menu entry"))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
782 ;; Return point to the menu and insert the title. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
783 (end-of-line) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
784 (delete-region |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
785 (point) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
786 (save-excursion (skip-chars-backward " \t") (point))) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
787 (indent-to texinfo-column-for-description 2) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
788 (save-excursion (insert title)))) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
789 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
790 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
791 ;;; Handling description indentation |
107 | 792 |
18259 | 793 ;; Since the make-menu functions indent descriptions, these functions |
794 ;; are useful primarily for indenting a single menu specially. | |
107 | 795 |
796 (defun texinfo-indent-menu-description (column &optional region-p) | |
19110 | 797 "Indent every description in menu following point to COLUMN. |
107 | 798 Non-nil argument (prefix, if interactive) means indent every |
799 description in every menu in the region. Does not indent second and | |
800 subsequent lines of a multi-line description." | |
19110 | 801 |
107 | 802 (interactive |
803 "nIndent menu descriptions to (column number): \nP") | |
804 (save-excursion | |
805 (save-restriction | |
806 (widen) | |
807 (if (not region-p) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
808 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
809 (re-search-forward "^@menu") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
810 (texinfo-menu-indent-description column) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
811 (message |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
812 "Indented descriptions in menu. You may save the buffer.")) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
813 ;;else |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
814 (message "Indenting every menu description in region... ") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
815 (goto-char (region-beginning)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
816 (while (and (< (point) (region-end)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
817 (texinfo-locate-menu-p)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
818 (forward-line 1) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
819 (texinfo-menu-indent-description column)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
820 (message "Indenting done. You may save the buffer."))))) |
107 | 821 |
822 (defun texinfo-menu-indent-description (to-column-number) | |
823 "Indent the Texinfo file menu description to TO-COLUMN-NUMBER. | |
824 Start with point just after the word `menu' in the `@menu' line and | |
825 leave point on the line before the `@end menu' line. Does not indent | |
826 second and subsequent lines of a multi-line description." | |
827 (let* ((beginning-of-next-line (point))) | |
828 (while (< beginning-of-next-line | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
829 (save-excursion ; beginning of end menu line |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
830 (goto-char (texinfo-menu-end)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
831 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
832 (point))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
833 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
834 (when (re-search-forward "\\* \\(.*::\\|.*: [^.,\t\n]+[.,\t]\\)" |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
835 (texinfo-menu-end) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
836 t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
837 (let ((beginning-white-space (point))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
838 (skip-chars-forward " \t") ; skip over spaces |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
839 (if (looking-at "\\(@\\|\\w\\)+") ; if there is text |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
840 (progn |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
841 ;; remove pre-existing indentation |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
842 (delete-region beginning-white-space (point)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
843 (indent-to-column to-column-number))))) |
107 | 844 ;; position point at beginning of next line |
19110 | 845 (forward-line 1) |
107 | 846 (setq beginning-of-next-line (point))))) |
847 | |
848 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
849 ;;; Making the master menu |
107 | 850 |
851 (defun texinfo-master-menu (update-all-nodes-menus-p) | |
852 "Make a master menu for a whole Texinfo file. | |
853 Non-nil argument (prefix, if interactive) means first update all | |
854 existing nodes and menus. Remove pre-existing master menu, if there is one. | |
855 | |
856 This function creates a master menu that follows the top node. The | |
857 master menu includes every entry from all the other menus. It | |
858 replaces any existing ordinary menu that follows the top node. | |
859 | |
860 If called with a non-nil argument, this function first updates all the | |
861 menus in the buffer (incorporating descriptions from pre-existing | |
862 menus) before it constructs the master menu. | |
863 | |
864 The function removes the detailed part of an already existing master | |
14009
dbc49672f847
(texinfo-master-menu): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
13354
diff
changeset
|
865 menu. This action depends on the pre-existing master menu using the |
107 | 866 standard `texinfo-master-menu-header'. |
867 | |
868 The master menu has the following format, which is adapted from the | |
869 recommendation in the Texinfo Manual: | |
870 | |
871 * The first part contains the major nodes in the Texinfo file: the | |
872 nodes for the chapters, chapter-like sections, and the major | |
873 appendices. This includes the indices, so long as they are in | |
874 chapter-like sections, such as unnumbered sections. | |
875 | |
876 * The second and subsequent parts contain a listing of the other, | |
877 lower level menus, in order. This way, an inquirer can go | |
878 directly to a particular node if he or she is searching for | |
879 specific information. | |
880 | |
881 Each of the menus in the detailed node listing is introduced by the | |
43430
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
882 title of the section containing the menu. |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
883 |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
884 Indents the first line of descriptions, and leaves trailing whitespace |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
885 in a menu that lacks descriptions, so descriptions will format well. |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
886 In general, a menu should contain descriptions, because node names and |
5288b3225c40
(texinfo-insert-menu): Explain in doc string that
Robert J. Chassell <bob@rattlesnake.com>
parents:
40390
diff
changeset
|
887 section titles are often too short to explain a node well." |
19110 | 888 |
107 | 889 (interactive "P") |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
890 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
891 (widen) |
107 | 892 (goto-char (point-min)) |
19110 | 893 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
894 ;; Move point to location after `top'. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
895 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t)) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
896 (error "This buffer needs a Top node")) |
19110 | 897 |
898 (let ((first-chapter | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
899 (save-excursion |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
900 (or (re-search-forward "^@node" nil t) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
901 (error "Too few nodes for a master menu")) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
902 (point)))) |
18849
b4b2ad407ba0
(texinfo-all-menus-update)
Richard M. Stallman <rms@gnu.org>
parents:
18259
diff
changeset
|
903 (if (search-forward texinfo-master-menu-header first-chapter t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
904 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
905 ;; Check if @detailmenu kludge is used; |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
906 ;; if so, leave point before @detailmenu. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
907 (search-backward "\n@detailmenu" |
18259 | 908 (save-excursion (forward-line -3) (point)) |
909 t) | |
910 ;; Remove detailed master menu listing | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
911 (goto-char (match-beginning 0)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
912 (let ((end-of-detailed-menu-descriptions |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
913 (save-excursion ; beginning of end menu line |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
914 (goto-char (texinfo-menu-end)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
915 (beginning-of-line) (forward-char -1) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
916 (point)))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
917 (delete-region (point) end-of-detailed-menu-descriptions))))) |
19110 | 918 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
919 (if update-all-nodes-menus-p |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
920 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
921 (message "Making a master menu in %s ...first updating all nodes... " |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
922 (buffer-name)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
923 (texinfo-update-node (point-min) (point-max)) |
19110 | 924 |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
925 (message "Updating all menus in %s ... " (buffer-name)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
926 (texinfo-make-menu (point-min) (point-max)))) |
19110 | 927 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
928 (message "Now making the master menu in %s... " (buffer-name)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
929 (goto-char (point-min)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
930 (texinfo-insert-master-menu-list |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
931 (texinfo-master-menu-list)) |
19110 | 932 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
933 ;; Remove extra newlines that texinfo-insert-master-menu-list |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
934 ;; may have inserted. |
19110 | 935 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
936 (save-excursion |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
937 (goto-char (point-min)) |
19110 | 938 |
18849
b4b2ad407ba0
(texinfo-all-menus-update)
Richard M. Stallman <rms@gnu.org>
parents:
18259
diff
changeset
|
939 (if (search-forward texinfo-master-menu-header nil t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
940 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
941 (goto-char (match-beginning 0)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
942 ;; Check if @detailmenu kludge is used; |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
943 ;; if so, leave point before @detailmenu. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
944 (search-backward "\n@detailmenu" |
18259 | 945 (save-excursion (forward-line -3) (point)) |
946 t) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
947 (insert "\n") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
948 (delete-blank-lines) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
949 (goto-char (point-min)))) |
107 | 950 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
951 (re-search-forward "^@menu") |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
952 (forward-line -1) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
953 (delete-blank-lines) |
19110 | 954 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
955 (re-search-forward "^@end menu") |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
956 (forward-line 1) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
957 (delete-blank-lines)) |
19110 | 958 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
959 (message |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
960 "Done...completed making master menu. You may save the buffer."))) |
107 | 961 |
962 (defun texinfo-master-menu-list () | |
963 "Return a list of menu entries and header lines for the master menu. | |
964 | |
965 Start with the menu for chapters and indices and then find each | |
966 following menu and the title of the node preceding that menu. | |
967 | |
968 The master menu list has this form: | |
969 | |
970 \(\(\(... \"entry-1-2\" \"entry-1\"\) \"title-1\"\) | |
971 \(\(... \"entry-2-2\" \"entry-2-1\"\) \"title-2\"\) | |
972 ...\) | |
973 | |
974 However, there does not need to be a title field." | |
975 | |
976 (let (master-menu-list) | |
977 (while (texinfo-locate-menu-p) | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
978 (push (list (texinfo-copy-menu) (texinfo-copy-menu-title)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
979 master-menu-list)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
980 (nreverse master-menu-list))) |
107 | 981 |
982 (defun texinfo-insert-master-menu-list (master-menu-list) | |
983 "Format and insert the master menu in the current buffer." | |
984 (goto-char (point-min)) | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
985 ;; Insert a master menu only after `Top' node and before next node |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
986 ;; \(or include file if there is no next node\). |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
987 (unless (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
988 (error "This buffer needs a Top node")) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
989 (let ((first-chapter |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
990 (save-excursion (re-search-forward "^@node\\|^@include") (point)))) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
991 (unless (re-search-forward "^@menu" first-chapter t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
992 (error "Buffer lacks ordinary `Top' menu in which to insert master"))) |
107 | 993 (beginning-of-line) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
994 (delete-region ; buffer must have ordinary top menu |
19110 | 995 (point) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
996 (save-excursion (re-search-forward "^@end menu") (point))) |
19110 | 997 |
998 (save-excursion | |
999 ;; `master-menu-inserted-p' is a kludge to tell | |
18259 | 1000 ;; whether to insert @end detailmenu (see bleow) |
1001 (let (master-menu-inserted-p) | |
1002 ;; Handle top of menu | |
1003 (insert "\n@menu\n") | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1004 ;; Insert chapter menu entries. Tell user what is going on. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1005 (message "Inserting chapter menu entry: %s ... " |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1006 (car (car master-menu-list))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1007 (dolist (entry (reverse (car (car master-menu-list)))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1008 (insert "* " entry "\n")) |
19110 | 1009 |
18259 | 1010 (setq master-menu-list (cdr master-menu-list)) |
19110 | 1011 |
18259 | 1012 ;; Only insert detailed master menu if there is one.... |
1013 (if (car (car master-menu-list)) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1014 (progn (setq master-menu-inserted-p t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1015 (insert (concat "\n@detailmenu\n" |
22396
6c7d7f953f08
(texinfo-insert-master-menu-list): Insert \n after @detailmenu.
Richard M. Stallman <rms@gnu.org>
parents:
21180
diff
changeset
|
1016 texinfo-master-menu-header)))) |
18259 | 1017 |
1018 ;; @detailmenu added 5 Sept 1996 to `texinfo-master-menu-header' | |
1019 ;; at Karl Berry's request to avert a bug in `makeinfo'; | |
1020 ;; all agree this is a bad kludge and should eventually be removed. | |
1021 ;; @detailmenu ... @end detailmenu is a noop in `texinfmt.el'. | |
1022 ;; See @end detailmenu below; | |
1023 ;; also see `texinfo-all-menus-update' above, `texinfo-master-menu', | |
1024 ;; `texinfo-multiple-files-update'. | |
17518
1eecbe9dd89c
(texinfo-master-menu-header): Delete newline at start.
Richard M. Stallman <rms@gnu.org>
parents:
17311
diff
changeset
|
1025 |
18259 | 1026 ;; Now, insert all the other menus |
19110 | 1027 |
18259 | 1028 ;; The menu master-menu-list has a form like this: |
1029 ;; ((("beta" "alpha") "title-A") | |
1030 ;; (("delta" "gamma") "title-B")) | |
19110 | 1031 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1032 (dolist (menu master-menu-list) |
19110 | 1033 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1034 (message "Inserting menu for %s .... " (cadr menu)) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1035 ;; insert title of menu section |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1036 (insert "\n" (cadr menu) "\n\n") |
19110 | 1037 |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1038 ;; insert each menu entry |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1039 (dolist (entry (reverse (car menu))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1040 (insert "* " entry "\n"))) |
19110 | 1041 |
18259 | 1042 ;; Finish menu |
17518
1eecbe9dd89c
(texinfo-master-menu-header): Delete newline at start.
Richard M. Stallman <rms@gnu.org>
parents:
17311
diff
changeset
|
1043 |
18259 | 1044 ;; @detailmenu (see note above) |
1045 ;; Only insert @end detailmenu if a master menu was inserted. | |
1046 (if master-menu-inserted-p | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1047 (insert "\n@end detailmenu")) |
18259 | 1048 (insert "\n@end menu\n\n")))) |
107 | 1049 |
1050 (defun texinfo-locate-menu-p () | |
1051 "Find the next menu in the texinfo file. | |
1052 If found, leave point after word `menu' on the `@menu' line, and return t. | |
1053 If a menu is not found, do not move point and return nil." | |
1054 (re-search-forward "\\(^@menu\\)" nil t)) | |
1055 | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1056 (defun texinfo-copy-menu-title () |
107 | 1057 "Return the title of the section preceding the menu as a string. |
1058 If such a title cannot be found, return an empty string. Do not move | |
1059 point." | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1060 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1061 (save-excursion |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1062 (if (re-search-backward |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1063 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1064 "\\(^@top" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1065 "\\|" ; or |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1066 texinfo-section-types-regexp ; all other section types |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1067 "\\)") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1068 nil |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1069 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1070 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1071 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1072 (forward-word 1) ; skip over section type |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1073 (skip-chars-forward " \t") ; and over spaces |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1074 (buffer-substring |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1075 (point) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1076 (progn (end-of-line) (point)))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1077 "")))) |
107 | 1078 |
1079 (defun texinfo-copy-menu () | |
1080 "Return the entries of an existing menu as a list. | |
1081 Start with point just after the word `menu' in the `@menu' line | |
1082 and leave point on the line before the `@end menu' line." | |
1083 (let* (this-menu-list | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1084 (end-of-menu (texinfo-menu-end)) ; position of end of `@end menu' |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1085 (last-entry (save-excursion ; position of beginning of |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1086 ; last `* ' entry |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1087 (goto-char end-of-menu) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1088 ;; handle multi-line description |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1089 (if (not (re-search-backward "^\\* " nil t)) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
1090 (error "No entries in menu")) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1091 (point)))) |
107 | 1092 (while (< (point) last-entry) |
15363
d401fcd58f8c
(texinfo-copy-menu): Use double backslash to quote regexp.
Karl Heuer <kwzh@gnu.org>
parents:
15362
diff
changeset
|
1093 (if (re-search-forward "^\\* " end-of-menu t) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1094 (push (buffer-substring |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1095 (point) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1096 ;; copy multi-line descriptions |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1097 (save-excursion |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1098 (re-search-forward "\\(^\\* \\|^@e\\)" nil t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1099 (- (point) 3))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1100 this-menu-list))) |
107 | 1101 this-menu-list)) |
1102 | |
1103 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1104 ;;; Determining the hierarchical level in the texinfo file |
107 | 1105 |
19110 | 1106 (defun texinfo-specific-section-type () |
107 | 1107 "Return the specific type of next section, as a string. |
1108 For example, \"unnumberedsubsec\". Return \"top\" for top node. | |
1109 | |
1110 Searches forward for a section. Hence, point must be before the | |
1111 section whose type will be found. Does not move point. Signal an | |
1112 error if the node is not the top node and a section is not found." | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1113 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1114 (save-excursion |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1115 (cond |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1116 ((re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1117 ;; Following search limit by cph but causes a bug |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1118 ;;(line-end-position) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1119 nil |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1120 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1121 "top") |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1122 ((re-search-forward texinfo-section-types-regexp nil t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1123 (buffer-substring-no-properties |
12698
e04324240c6b
(texinfo-specific-section-type): Use buffer-substring-no-properties.
Richard M. Stallman <rms@gnu.org>
parents:
11929
diff
changeset
|
1124 (progn (beginning-of-line) ; copy its name |
e04324240c6b
(texinfo-specific-section-type): Use buffer-substring-no-properties.
Richard M. Stallman <rms@gnu.org>
parents:
11929
diff
changeset
|
1125 (1+ (point))) |
e04324240c6b
(texinfo-specific-section-type): Use buffer-substring-no-properties.
Richard M. Stallman <rms@gnu.org>
parents:
11929
diff
changeset
|
1126 (progn (forward-word 1) |
e04324240c6b
(texinfo-specific-section-type): Use buffer-substring-no-properties.
Richard M. Stallman <rms@gnu.org>
parents:
11929
diff
changeset
|
1127 (point)))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1128 (t |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1129 (error |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
1130 "texinfo-specific-section-type: Chapter or section not found")))))) |
107 | 1131 |
1132 (defun texinfo-hierarchic-level () | |
1133 "Return the general hierarchal level of the next node in a texinfo file. | |
1134 Thus, a subheading or appendixsubsec is of type subsection." | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1135 (let ((case-fold-search t)) |
33258
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1136 (cadr (assoc |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1137 (texinfo-specific-section-type) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1138 texinfo-section-list)))) |
107 | 1139 |
1140 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1141 ;;; Locating the major positions |
107 | 1142 |
19110 | 1143 (defun texinfo-update-menu-region-beginning (level) |
107 | 1144 "Locate beginning of higher level section this section is within. |
1145 Return position of the beginning of the node line; do not move point. | |
1146 Thus, if this level is subsection, searches backwards for section node. | |
1147 Only argument is a string of the general type of section." | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1148 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1149 ;; !! Known bug: if section immediately follows top node, this |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1150 ;; returns the beginning of the buffer as the beginning of the |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1151 ;; higher level section. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1152 (cond |
33258
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1153 ((< level 3) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1154 (save-excursion |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1155 (goto-char (point-min)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1156 (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1157 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1158 (point))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1159 (t |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1160 (save-excursion |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1161 (re-search-backward |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1162 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1163 "\\(^@node\\).*\n" ; match node line |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1164 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1165 "\\|" ; or |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1166 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1167 "\\|" ; or |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1168 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1169 "\\)?" ; end of expression |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1170 (eval |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1171 (cdr (assoc level texinfo-update-menu-higher-regexps)))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1172 nil |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1173 'goto-beginning) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1174 (point)))))) |
107 | 1175 |
19110 | 1176 (defun texinfo-update-menu-region-end (level) |
107 | 1177 "Locate end of higher level section this section is within. |
1178 Return position; do not move point. Thus, if this level is a | |
1179 subsection, find the node for the section this subsection is within. | |
1180 If level is top or chapter, returns end of file. Only argument is a | |
1181 string of the general type of section." | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1182 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1183 (save-excursion |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1184 (if (re-search-forward |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1185 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1186 "\\(^@node\\).*\n" ; match node line |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1187 "\\(\\(\\(^@c\\).*\n\\)" ; match comment line, if any |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1188 "\\|" ; or |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1189 "\\(^@ifinfo[ ]*\n\\)" ; ifinfo line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1190 "\\|" ; or |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1191 "\\(^@ifnottex[ ]*\n\\)" ; ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1192 "\\)?" ; end of expression |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1193 (eval |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1194 ;; Never finds end of level above chapter so goes to end. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1195 (cdr (assoc level texinfo-update-menu-higher-regexps)))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1196 nil |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1197 'goto-end) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1198 (match-beginning 1) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1199 (point-max))))) |
107 | 1200 |
1201 (defun texinfo-menu-first-node (beginning end) | |
19110 | 1202 "Locate first node of the section the menu will be placed in. |
107 | 1203 Return position; do not move point. |
19110 | 1204 The menu will be located just before this position. |
107 | 1205 |
1206 First argument is the position of the beginning of the section in | |
1207 which the menu will be located; second argument is the position of the | |
1208 end of that region; it limits the search." | |
19110 | 1209 |
107 | 1210 (save-excursion |
1211 (goto-char beginning) | |
1212 (forward-line 1) | |
1213 (re-search-forward "^@node" end t) | |
1214 (beginning-of-line) | |
1215 (point))) | |
1216 | |
1217 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1218 ;;; Updating a node |
107 | 1219 |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1220 (defun texinfo-update-node (&optional beginning end) |
107 | 1221 "Without any prefix argument, update the node in which point is located. |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1222 Interactively, a prefix argument means to operate on the region. |
107 | 1223 |
1224 The functions for creating or updating nodes and menus, and their | |
1225 keybindings, are: | |
1226 | |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1227 texinfo-update-node (&optional beginning end) \\[texinfo-update-node] |
107 | 1228 texinfo-every-node-update () \\[texinfo-every-node-update] |
1229 texinfo-sequential-node-update (&optional region-p) | |
1230 | |
1231 texinfo-make-menu (&optional region-p) \\[texinfo-make-menu] | |
1232 texinfo-all-menus-update () \\[texinfo-all-menus-update] | |
1233 texinfo-master-menu () | |
1234 | |
1235 texinfo-indent-menu-description (column &optional region-p) | |
1236 | |
1237 The `texinfo-column-for-description' variable specifies the column to | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1238 which menu descriptions are indented. Its default value is 32." |
19110 | 1239 |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1240 (interactive |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1241 (if prefix-arg |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1242 (list (point) (mark)))) |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1243 (if (null beginning) |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1244 ;; Update a single node. |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1245 (let ((auto-fill-function nil)) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1246 (if (not (re-search-backward "^@node" (point-min) t)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1247 (error "Node line not found before this position")) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1248 (texinfo-update-the-node) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1249 (message "Done...updated the node. You may save the buffer.")) |
107 | 1250 ;; else |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1251 (let ((auto-fill-function nil)) |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1252 (save-excursion |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1253 (save-restriction |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1254 (narrow-to-region beginning end) |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1255 (goto-char (point-min)) |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1256 (while (re-search-forward "^@node" (point-max) t) |
19110 | 1257 (beginning-of-line) |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1258 (texinfo-update-the-node)) |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1259 (goto-char (point-max)) |
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1260 (message "Done...nodes updated in region. You may save the buffer.")))))) |
107 | 1261 |
1262 (defun texinfo-every-node-update () | |
1263 "Update every node in a Texinfo file." | |
1264 (interactive) | |
1265 (save-excursion | |
17311
f76a73cf699e
(texinfo-make-menu): Accept args BEGINNING and END.
Richard M. Stallman <rms@gnu.org>
parents:
16858
diff
changeset
|
1266 (texinfo-update-node (point-min) (point-max)) |
38877
408ff1ad3d3a
(texinfo-every-node-update): Remove
Gerd Moellmann <gerd@gnu.org>
parents:
38851
diff
changeset
|
1267 (message "Done...updated every node. You may save the buffer."))) |
107 | 1268 |
1269 (defun texinfo-update-the-node () | |
19110 | 1270 "Update one node. Point must be at the beginning of node line. |
107 | 1271 Leave point at the end of the node line." |
1272 (texinfo-check-for-node-name) | |
1273 (texinfo-delete-existing-pointers) | |
1274 (message "Updating node: %s ... " (texinfo-copy-node-name)) | |
1275 (save-restriction | |
1276 (widen) | |
1277 (let* | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1278 ((case-fold-search t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1279 (level (texinfo-hierarchic-level)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1280 (beginning (texinfo-update-menu-region-beginning level)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1281 (end (texinfo-update-menu-region-end level))) |
33258
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1282 (if (eq level 1) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1283 (texinfo-top-pointer-case) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1284 ;; else |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1285 (texinfo-insert-pointer beginning end level 'next) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1286 (texinfo-insert-pointer beginning end level 'previous) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1287 (texinfo-insert-pointer beginning end level 'up) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1288 (texinfo-clean-up-node-line))))) |
107 | 1289 |
1290 (defun texinfo-top-pointer-case () | |
1291 "Insert pointers in the Top node. This is a special case. | |
1292 | |
1293 The `Next' pointer is a pointer to a chapter or section at a lower | |
1294 hierarchical level in the file. The `Previous' and `Up' pointers are | |
1295 to `(dir)'. Point must be at the beginning of the node line, and is | |
1296 left at the end of the node line." | |
1297 | |
1298 (texinfo-clean-up-node-line) | |
19110 | 1299 (insert ", " |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1300 (save-excursion |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1301 ;; There may be an @chapter or other such command between |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1302 ;; the top node line and the next node line, as a title |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1303 ;; for an `ifinfo' section. This @chapter command must |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1304 ;; must be skipped. So the procedure is to search for |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1305 ;; the next `@node' line, and then copy its name. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1306 (if (re-search-forward "^@node" nil t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1307 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1308 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1309 (texinfo-copy-node-name)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1310 " ")) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1311 ", (dir), (dir)")) |
107 | 1312 |
1313 (defun texinfo-check-for-node-name () | |
1314 "Determine whether the node has a node name. Prompt for one if not. | |
1315 Point must be at beginning of node line. Does not move point." | |
1316 (save-excursion | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1317 (let ((initial (texinfo-copy-next-section-title))) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1318 ;; This is not clean. Use `interactive' to read the arg. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1319 (forward-word 1) ; skip over node command |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1320 (skip-chars-forward " \t") ; and over spaces |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1321 (if (not (looking-at "[^,\t\n ]+")) ; regexp based on what Info looks for |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1322 ; alternatively, use "[a-zA-Z]+" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1323 (let ((node-name |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1324 (read-from-minibuffer |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1325 "Node name (use no @, commas, colons, or apostrophes): " |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1326 initial))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1327 (insert " " node-name)))))) |
107 | 1328 |
1329 (defun texinfo-delete-existing-pointers () | |
19110 | 1330 "Delete `Next', `Previous', and `Up' pointers. |
107 | 1331 Starts from the current position of the cursor, and searches forward |
1332 on the line for a comma and if one is found, deletes the rest of the | |
1333 line, including the comma. Leaves point at beginning of line." | |
11929
46487d19cdb3
(texinfo-sequentially-find-pointer): Don't modify
Karl Heuer <kwzh@gnu.org>
parents:
7432
diff
changeset
|
1334 (let ((eol-point (save-excursion (end-of-line) (point)))) |
46487d19cdb3
(texinfo-sequentially-find-pointer): Don't modify
Karl Heuer <kwzh@gnu.org>
parents:
7432
diff
changeset
|
1335 (if (search-forward "," eol-point t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1336 (delete-region (1- (point)) eol-point))) |
107 | 1337 (beginning-of-line)) |
1338 | |
1339 (defun texinfo-find-pointer (beginning end level direction) | |
1340 "Move point to section associated with next, previous, or up pointer. | |
18259 | 1341 Return type of pointer (either `normal' or `no-pointer'). |
107 | 1342 |
1343 The first and second arguments bound the search for a pointer to the | |
1344 beginning and end, respectively, of the enclosing higher level | |
1345 section. The third argument is a string specifying the general kind | |
15362
66fb24beae54
(texinfo-find-pointer): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
14169
diff
changeset
|
1346 of section such as \"chapter\" or \"section\". When looking for the |
107 | 1347 `Next' pointer, the section found will be at the same hierarchical |
1348 level in the Texinfo file; when looking for the `Previous' pointer, | |
1349 the section found will be at the same or higher hierarchical level in | |
1350 the Texinfo file; when looking for the `Up' pointer, the section found | |
1351 will be at some level higher in the Texinfo file. The fourth argument | |
1352 \(one of 'next, 'previous, or 'up\) specifies whether to find the | |
1353 `Next', `Previous', or `Up' pointer." | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1354 (let ((case-fold-search t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1355 (cond ((eq direction 'next) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1356 (forward-line 3) ; skip over current node |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1357 ;; Search for section commands accompanied by node lines; |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1358 ;; ignore section commands in the middle of nodes. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1359 (if (re-search-forward |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1360 ;; A `Top' node is never a next pointer, so won't find it. |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1361 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1362 ;; Match node line. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1363 "\\(^@node\\).*\n" |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1364 ;; Match comment, ifinfo, ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1365 (concat |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1366 "\\(\\(" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1367 "\\(^@c\\).*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1368 "\\|" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1369 "\\(^@ifinfo[ ]*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1370 "\\|" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1371 "\\(^@ifnottex[ ]*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1372 "\\)?") |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1373 (eval |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1374 (cdr (assoc level texinfo-update-menu-same-level-regexps)))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1375 end |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1376 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1377 'normal |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1378 'no-pointer)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1379 ((eq direction 'previous) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1380 (if (re-search-backward |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1381 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1382 "\\(" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1383 ;; Match node line. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1384 "\\(^@node\\).*\n" |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1385 ;; Match comment, ifinfo, ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1386 (concat |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1387 "\\(\\(" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1388 "\\(^@c\\).*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1389 "\\|" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1390 "\\(^@ifinfo[ ]*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1391 "\\|" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1392 "\\(^@ifnottex[ ]*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1393 "\\)?") |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1394 (eval |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1395 (cdr (assoc level texinfo-update-menu-same-level-regexps))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1396 "\\|" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1397 ;; Match node line. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1398 "\\(^@node\\).*\n" |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1399 ;; Match comment, ifinfo, ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1400 (concat |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1401 "\\(\\(" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1402 "\\(^@c\\).*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1403 "\\|" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1404 "\\(^@ifinfo[ ]*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1405 "\\|" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1406 "\\(^@ifnottex[ ]*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1407 "\\)?") |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1408 (eval |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1409 (cdr (assoc level texinfo-update-menu-higher-regexps))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1410 "\\|" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1411 ;; Handle `Top' node specially. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1412 "^@node [ \t]*top[ \t]*\\(,\\|$\\)" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1413 "\\)") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1414 beginning |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1415 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1416 'normal |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1417 'no-pointer)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1418 ((eq direction 'up) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1419 (if (re-search-backward |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1420 (concat |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1421 "\\(" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1422 ;; Match node line. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1423 "\\(^@node\\).*\n" |
38851
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1424 ;; Match comment, ifinfo, ifnottex line, if any |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1425 (concat |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1426 "\\(\\(" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1427 "\\(^@c\\).*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1428 "\\|" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1429 "\\(^@ifinfo[ ]*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1430 "\\|" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1431 "\\(^@ifnottex[ ]*\n\\)" |
0d7b71525b45
Update copyright notice, fix minor
Gerd Moellmann <gerd@gnu.org>
parents:
38436
diff
changeset
|
1432 "\\)?") |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1433 (eval (cdr (assoc level texinfo-update-menu-higher-regexps))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1434 "\\|" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1435 ;; Handle `Top' node specially. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1436 "^@node [ \t]*top[ \t]*\\(,\\|$\\)" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1437 "\\)") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1438 (save-excursion |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1439 (goto-char beginning) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1440 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1441 (point)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1442 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1443 'normal |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1444 'no-pointer)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1445 (t |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1446 (error "texinfo-find-pointer: lack proper arguments"))))) |
107 | 1447 |
1448 (defun texinfo-pointer-name (kind) | |
1449 "Return the node name preceding the section command. | |
18259 | 1450 The argument is the kind of section, either `normal' or `no-pointer'." |
107 | 1451 (let (name) |
1452 (cond ((eq kind 'normal) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1453 (end-of-line) ; this handles prev node top case |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1454 (re-search-backward ; when point is already |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1455 "^@node" ; at the beginning of @node line |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1456 (save-excursion (forward-line -3)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1457 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1458 (setq name (texinfo-copy-node-name))) |
107 | 1459 ((eq kind 'no-pointer) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1460 ;; Don't need to put a blank in the pointer slot, |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1461 ;; since insert "' " always has a space |
107 | 1462 (setq name " "))) ; put a blank in the pointer slot |
1463 name)) | |
1464 | |
1465 (defun texinfo-insert-pointer (beginning end level direction) | |
1466 "Insert the `Next', `Previous' or `Up' node name at point. | |
19110 | 1467 Move point forward. |
107 | 1468 |
1469 The first and second arguments bound the search for a pointer to the | |
1470 beginning and end, respectively, of the enclosing higher level | |
1471 section. The third argument is the hierarchical level of the Texinfo | |
1472 file, a string such as \"section\". The fourth argument is direction | |
18259 | 1473 towards which the pointer is directed, one of `next', `previous', or `up'." |
107 | 1474 |
1475 (end-of-line) | |
1476 (insert | |
1477 ", " | |
1478 (save-excursion | |
1479 (texinfo-pointer-name | |
1480 (texinfo-find-pointer beginning end level direction))))) | |
1481 | |
1482 (defun texinfo-clean-up-node-line () | |
1483 "Remove extra commas, if any, at end of node line." | |
1484 (end-of-line) | |
1485 (skip-chars-backward ", ") | |
1486 (delete-region (point) (save-excursion (end-of-line) (point)))) | |
1487 | |
1488 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1489 ;;; Updating nodes sequentially |
18259 | 1490 ;; These sequential update functions insert `Next' or `Previous' |
1491 ;; pointers that point to the following or preceding nodes even if they | |
1492 ;; are at higher or lower hierarchical levels. This means that if a | |
1493 ;; section contains one or more subsections, the section's `Next' | |
1494 ;; pointer will point to the subsection and not the following section. | |
1495 ;; (The subsection to which `Next' points will most likely be the first | |
1496 ;; item on the section's menu.) | |
107 | 1497 |
1498 (defun texinfo-sequential-node-update (&optional region-p) | |
1499 "Update one node (or many) in a Texinfo file with sequential pointers. | |
1500 | |
1501 This function causes the `Next' or `Previous' pointer to point to the | |
1502 immediately preceding or following node, even if it is at a higher or | |
1503 lower hierarchical level in the document. Continually pressing `n' or | |
1504 `p' takes you straight through the file. | |
1505 | |
1506 Without any prefix argument, update the node in which point is located. | |
1507 Non-nil argument (prefix, if interactive) means update the nodes in the | |
1508 marked region. | |
1509 | |
1510 This command makes it awkward to navigate among sections and | |
1511 subsections; it should be used only for those documents that are meant | |
1512 to be read like a novel rather than a reference, and for which the | |
1513 Info `g*' command is inadequate." | |
19110 | 1514 |
107 | 1515 (interactive "P") |
1516 (if (not region-p) | |
4029
8bf916902edc
(texinfo-update-node): Bind auto-fill-hook as well as auto-fill-function.
Richard M. Stallman <rms@gnu.org>
parents:
4028
diff
changeset
|
1517 ;; update a single node |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1518 (let ((auto-fill-function nil)) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1519 (if (not (re-search-backward "^@node" (point-min) t)) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
1520 (error "Node line not found before this position")) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1521 (texinfo-sequentially-update-the-node) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1522 (message |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1523 "Done...sequentially updated the node . You may save the buffer.")) |
107 | 1524 ;; else |
732 | 1525 (let ((auto-fill-function nil) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1526 (beginning (region-beginning)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1527 (end (region-end))) |
107 | 1528 (if (= end beginning) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
1529 (error "Please mark a region")) |
107 | 1530 (save-restriction |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1531 (narrow-to-region beginning end) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1532 (goto-char beginning) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1533 (push-mark (point) t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1534 (while (re-search-forward "^@node" (point-max) t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1535 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1536 (texinfo-sequentially-update-the-node)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1537 (message |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1538 "Done...updated the nodes in sequence. You may save the buffer."))))) |
107 | 1539 |
1540 (defun texinfo-sequentially-update-the-node () | |
19110 | 1541 "Update one node such that the pointers are sequential. |
107 | 1542 A `Next' or `Previous' pointer points to any preceding or following node, |
1543 regardless of its hierarchical level." | |
1544 | |
33258
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1545 (texinfo-check-for-node-name) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1546 (texinfo-delete-existing-pointers) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1547 (message |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1548 "Sequentially updating node: %s ... " (texinfo-copy-node-name)) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1549 (save-restriction |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1550 (widen) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1551 (let* ((case-fold-search t) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1552 (level (texinfo-hierarchic-level))) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1553 (if (eq level 1) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1554 (texinfo-top-pointer-case) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1555 ;; else |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1556 (texinfo-sequentially-insert-pointer level 'next) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1557 (texinfo-sequentially-insert-pointer level 'previous) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1558 (texinfo-sequentially-insert-pointer level 'up) |
e2ec8e65cd35
Require texinfo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25278
diff
changeset
|
1559 (texinfo-clean-up-node-line))))) |
107 | 1560 |
43660
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1561 (defun texinfo-sequentially-insert-pointer (level direction) |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1562 "Insert the `Next', `Previous' or `Up' node name at point. |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1563 Move point forward. |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1564 |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1565 The first argument is the hierarchical level of the Texinfo file, a |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1566 string such as \"section\". The second argument is direction, one of |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1567 `next', `previous', or `up'." |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1568 |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1569 (end-of-line) |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1570 (insert |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1571 ", " |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1572 (save-excursion |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1573 (texinfo-pointer-name |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1574 (texinfo-sequentially-find-pointer level direction))))) |
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1575 |
107 | 1576 (defun texinfo-sequentially-find-pointer (level direction) |
1577 "Find next or previous pointer sequentially in Texinfo file, or up pointer. | |
1578 Move point to section associated with the pointer. Find point even if | |
1579 it is in a different section. | |
1580 | |
18259 | 1581 Return type of pointer (either `normal' or `no-pointer'). |
107 | 1582 |
1583 The first argument is a string specifying the general kind of section | |
15362
66fb24beae54
(texinfo-find-pointer): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
14169
diff
changeset
|
1584 such as \"chapter\" or \"section\". The section found will be at the |
107 | 1585 same hierarchical level in the Texinfo file, or, in the case of the up |
18259 | 1586 pointer, some level higher. The second argument (one of `next', |
1587 `previous', or `up') specifies whether to find the `Next', `Previous', | |
107 | 1588 or `Up' pointer." |
19110 | 1589 (let ((case-fold-search t)) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1590 (cond ((eq direction 'next) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1591 (forward-line 3) ; skip over current node |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1592 (if (re-search-forward |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1593 texinfo-section-types-regexp |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1594 (point-max) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1595 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1596 'normal |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1597 'no-pointer)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1598 ((eq direction 'previous) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1599 (if (re-search-backward |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1600 texinfo-section-types-regexp |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1601 (point-min) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1602 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1603 'normal |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1604 'no-pointer)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1605 ((eq direction 'up) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1606 (if (re-search-backward |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1607 (eval (cdr (assoc level texinfo-update-menu-higher-regexps))) |
43660
77676c41d6fb
(texinfo-insert-menu): specify previously free variable `level' in a
Robert J. Chassell <bob@rattlesnake.com>
parents:
43612
diff
changeset
|
1608 (point-min) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1609 t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1610 'normal |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1611 'no-pointer)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1612 (t |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1613 (error "texinfo-sequential-find-pointer: lack proper arguments"))))) |
107 | 1614 |
1615 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1616 ;;; Inserting `@node' lines |
18259 | 1617 ;; The `texinfo-insert-node-lines' function inserts `@node' lines as needed |
1618 ;; before the `@chapter', `@section', and such like lines of a region | |
1619 ;; in a Texinfo file. | |
107 | 1620 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1621 (defun texinfo-insert-node-lines (beginning end &optional title-p) |
107 | 1622 "Insert missing `@node' lines in region of Texinfo file. |
1623 Non-nil argument (prefix, if interactive) means also to insert the | |
1624 section titles as node names; and also to insert the section titles as | |
18259 | 1625 node names in pre-existing `@node' lines that lack names." |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1626 (interactive "r\nP") |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1627 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1628 ;; Use marker; after inserting node lines, leave point at end of |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1629 ;; region and mark at beginning. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1630 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1631 (let (beginning-marker end-marker title last-section-position) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1632 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1633 ;; Save current position on mark ring and set mark to end. |
19110 | 1634 (push-mark end t) |
1635 (setq end-marker (mark-marker)) | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1636 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1637 (goto-char beginning) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1638 (while (re-search-forward |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1639 texinfo-section-types-regexp |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1640 end-marker |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1641 'end) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1642 ;; Copy title if desired. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1643 (if title-p |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1644 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1645 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1646 (forward-word 1) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1647 (skip-chars-forward " \t") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1648 (setq title (buffer-substring |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1649 (point) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1650 (save-excursion (end-of-line) (point)))))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1651 ;; Insert node line if necessary. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1652 (if (re-search-backward |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1653 "^@node" |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1654 ;; Avoid finding previous node line if node lines are close. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1655 (or last-section-position |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1656 (save-excursion (forward-line -2) (point))) t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1657 ;; @node is present, and point at beginning of that line |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1658 (forward-word 1) ; Leave point just after @node. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1659 ;; Else @node missing; insert one. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1660 (beginning-of-line) ; Beginning of `@section' line. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1661 (insert "@node\n") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1662 (backward-char 1)) ; Leave point just after `@node'. |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1663 ;; Insert title if desired. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1664 (if title-p |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1665 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1666 (skip-chars-forward " \t") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1667 ;; Use regexp based on what info looks for |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1668 ;; (alternatively, use "[a-zA-Z]+"); |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1669 ;; this means we only insert a title if none exists. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1670 (if (not (looking-at "[^,\t\n ]+")) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1671 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1672 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1673 (forward-word 1) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1674 (insert " " title) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1675 (message "Inserted title %s ... " title))))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1676 ;; Go forward beyond current section title. |
19110 | 1677 (re-search-forward texinfo-section-types-regexp |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1678 (save-excursion (forward-line 3) (point)) t) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1679 (setq last-section-position (point)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1680 (forward-line 1)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1681 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1682 ;; Leave point at end of region, mark at beginning. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1683 (set-mark beginning) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1684 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1685 (if title-p |
107 | 1686 (message |
1687 "Done inserting node lines and titles. You may save the buffer.") | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1688 (message "Done inserting node lines. You may save the buffer.")))) |
107 | 1689 |
1690 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1691 ;;; Update and create menus for multi-file Texinfo sources |
107 | 1692 |
19110 | 1693 ;; 1. M-x texinfo-multiple-files-update |
107 | 1694 ;; |
1695 ;; Read the include file list of an outer Texinfo file and | |
1696 ;; update all highest level nodes in the files listed and insert a | |
1697 ;; main menu in the outer file after its top node. | |
1698 | |
19110 | 1699 ;; 2. C-u M-x texinfo-multiple-files-update |
107 | 1700 ;; |
1701 ;; Same as 1, but insert a master menu. (Saves reupdating lower | |
1702 ;; level menus and nodes.) This command simply reads every menu, | |
1703 ;; so if the menus are wrong, the master menu will be wrong. | |
1704 ;; Similarly, if the lower level node pointers are wrong, they | |
1705 ;; will stay wrong. | |
1706 | |
19110 | 1707 ;; 3. C-u 2 M-x texinfo-multiple-files-update |
107 | 1708 ;; |
1709 ;; Read the include file list of an outer Texinfo file and | |
1710 ;; update all nodes and menus in the files listed and insert a | |
1711 ;; master menu in the outer file after its top node. | |
1712 | |
1713 ;;; Note: these functions: | |
1714 ;;; | |
1715 ;;; * Do not save or delete any buffers. You may fill up your memory. | |
19110 | 1716 ;;; * Do not handle any pre-existing nodes in outer file. |
107 | 1717 ;;; Hence, you may need a file for indices. |
1718 | |
1719 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1720 ;;; Auxiliary functions for multiple file updating |
107 | 1721 |
1722 (defun texinfo-multi-file-included-list (outer-file) | |
1723 "Return a list of the included files in OUTER-FILE." | |
1724 (let ((included-file-list (list outer-file)) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1725 start) |
107 | 1726 (save-excursion |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1727 (set-buffer (find-file-noselect outer-file)) |
107 | 1728 (widen) |
1729 (goto-char (point-min)) | |
1730 (while (re-search-forward "^@include" nil t) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1731 (skip-chars-forward " \t") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1732 (setq start (point)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1733 (end-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1734 (skip-chars-backward " \t") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1735 (setq included-file-list |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1736 (cons (buffer-substring start (point)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1737 included-file-list))) |
107 | 1738 (nreverse included-file-list)))) |
1739 | |
1740 (defun texinfo-copy-next-section-title () | |
1741 "Return the name of the immediately following section as a string. | |
1742 | |
1743 Start with point at the beginning of the node line. Leave point at the | |
1744 same place. If there is no title, returns an empty string." | |
1745 | |
1746 (save-excursion | |
1747 (end-of-line) | |
19110 | 1748 (let ((node-end (or |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1749 (save-excursion |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1750 (if (re-search-forward "\\(^@node\\)" nil t) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1751 (match-beginning 0))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1752 (point-max)))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1753 (if (re-search-forward texinfo-section-types-regexp node-end t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1754 (progn |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1755 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1756 ;; copy title |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1757 (let ((title |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1758 (buffer-substring |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1759 (progn (forward-word 1) ; skip over section type |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1760 (skip-chars-forward " \t") ; and over spaces |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1761 (point)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1762 (progn (end-of-line) (point))))) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1763 title)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1764 "")))) |
107 | 1765 |
1766 (defun texinfo-multi-file-update (files &optional update-everything) | |
1767 "Update first node pointers in each file in FILES. | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1768 Return a list of the node names. |
107 | 1769 |
1770 The first file in the list is an outer file; the remaining are | |
1771 files included in the outer file with `@include' commands. | |
1772 | |
1773 If optional arg UPDATE-EVERYTHING non-nil, update every menu and | |
1774 pointer in each of the included files. | |
1775 | |
1776 Also update the `Top' level node pointers of the outer file. | |
1777 | |
1778 Requirements: | |
1779 | |
1780 * the first file in the FILES list must be the outer file, | |
1781 * each of the included files must contain exactly one highest | |
19110 | 1782 hierarchical level node, |
107 | 1783 * this node must be the first node in the included file, |
1784 * each highest hierarchical level node must be of the same type. | |
1785 | |
53554
1bdcd59e6a40
(texinfo-multi-file-update): update documentation to state that
Robert J. Chassell <bob@rattlesnake.com>
parents:
53553
diff
changeset
|
1786 Thus, normally, each included file contains one, and only one, chapter. |
1bdcd59e6a40
(texinfo-multi-file-update): update documentation to state that
Robert J. Chassell <bob@rattlesnake.com>
parents:
53553
diff
changeset
|
1787 |
1bdcd59e6a40
(texinfo-multi-file-update): update documentation to state that
Robert J. Chassell <bob@rattlesnake.com>
parents:
53553
diff
changeset
|
1788 However, when an included file does not have any node lines in |
1bdcd59e6a40
(texinfo-multi-file-update): update documentation to state that
Robert J. Chassell <bob@rattlesnake.com>
parents:
53553
diff
changeset
|
1789 it, this command does not try to create a menu entry for it. |
1bdcd59e6a40
(texinfo-multi-file-update): update documentation to state that
Robert J. Chassell <bob@rattlesnake.com>
parents:
53553
diff
changeset
|
1790 Consequently, you can include any file, such as a version or an |
1bdcd59e6a40
(texinfo-multi-file-update): update documentation to state that
Robert J. Chassell <bob@rattlesnake.com>
parents:
53553
diff
changeset
|
1791 update file without node lines, not just files that are |
1bdcd59e6a40
(texinfo-multi-file-update): update documentation to state that
Robert J. Chassell <bob@rattlesnake.com>
parents:
53553
diff
changeset
|
1792 chapters." |
107 | 1793 |
18259 | 1794 ;; The menu-list has the form: |
19110 | 1795 ;; |
1796 ;; \(\(\"node-name1\" . \"title1\"\) | |
18259 | 1797 ;; \(\"node-name2\" . \"title2\"\) ... \) |
19110 | 1798 ;; |
18259 | 1799 ;; However, there does not need to be a title field and this function |
1800 ;; does not fill it; however a comment tells you how to do so. | |
1801 ;; You would use the title field if you wanted to insert titles in the | |
1802 ;; description slot of a menu as a description. | |
19110 | 1803 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1804 (let ((case-fold-search t) |
53315
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1805 menu-list next-node-name previous-node-name files-with-node-lines) |
19110 | 1806 |
53315
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1807 ;; Create a new list of included files that only have node lines |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1808 (while files |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1809 (set-buffer (find-file-noselect (car files))) |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1810 (widen) |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1811 (goto-char (point-min)) |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1812 (when (re-search-forward "^@node" nil t) |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1813 (setq files-with-node-lines (cons (car files) files-with-node-lines))) |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1814 (setq files (cdr files))) |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1815 (setq files-with-node-lines (nreverse files-with-node-lines)) |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1816 |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1817 ;; Find the name of the first node in a subsequent file |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1818 ;; and copy it into the variable next-node-name |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1819 (set-buffer (find-file-noselect (car (cdr files-with-node-lines)))) |
107 | 1820 (widen) |
1821 (goto-char (point-min)) | |
75627
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
1822 ;; The following search _must_ succeed, since we verified above |
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
1823 ;; that this file does have a @node line. |
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
1824 (re-search-forward "^@node" nil t) |
107 | 1825 (beginning-of-line) |
1826 (texinfo-check-for-node-name) | |
1827 (setq next-node-name (texinfo-copy-node-name)) | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1828 (push (cons next-node-name (prog1 "" (forward-line 1))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1829 ;; Use following to insert section titles automatically. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1830 ;; (texinfo-copy-next-section-title) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1831 menu-list) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1832 |
107 | 1833 ;; Go to outer file |
53315
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1834 ;; `pop' is analogous to (prog1 (car PLACE) (setf PLACE (cdr PLACE))) |
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1835 (set-buffer (find-file-noselect (pop files-with-node-lines))) |
107 | 1836 (goto-char (point-min)) |
143 | 1837 (if (not (re-search-forward "^@node [ \t]*top[ \t]*\\(,\\|$\\)" nil t)) |
38963
6e5457eb45b8
Remove dots and exclams from end of error messages. From Pavel Janik.
Eli Zaretskii <eliz@gnu.org>
parents:
38877
diff
changeset
|
1838 (error "This buffer needs a Top node")) |
107 | 1839 (beginning-of-line) |
1840 (texinfo-delete-existing-pointers) | |
1841 (end-of-line) | |
1842 (insert ", " next-node-name ", (dir), (dir)") | |
1843 (beginning-of-line) | |
1844 (setq previous-node-name "Top") | |
19110 | 1845 |
53315
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1846 (while files-with-node-lines |
19110 | 1847 |
53315
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1848 (if (not (cdr files-with-node-lines)) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1849 ;; No next file |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1850 (setq next-node-name "") |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1851 ;; Else, |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1852 ;; find the name of the first node in the next file. |
53315
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1853 (set-buffer (find-file-noselect (car (cdr files-with-node-lines)))) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1854 (widen) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1855 (goto-char (point-min)) |
75627
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
1856 ;; The following search _must_ succeed, since we verified |
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
1857 ;; above that files in files-with-node-lines do have a @node |
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
1858 ;; line. |
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
1859 (re-search-forward "^@node" nil t) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1860 (beginning-of-line) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1861 (texinfo-check-for-node-name) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1862 (setq next-node-name (texinfo-copy-node-name)) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1863 (push (cons next-node-name (prog1 "" (forward-line 1))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1864 ;; Use following to insert section titles automatically. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1865 ;; (texinfo-copy-next-section-title) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1866 menu-list)) |
107 | 1867 |
1868 ;; Go to node to be updated. | |
53315
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1869 (set-buffer (find-file-noselect (car files-with-node-lines))) |
107 | 1870 (goto-char (point-min)) |
1871 (beginning-of-line) | |
19110 | 1872 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1873 ;; Update other menus and nodes if requested. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1874 (if update-everything (texinfo-all-menus-update t)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1875 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1876 (beginning-of-line) |
107 | 1877 (texinfo-delete-existing-pointers) |
1878 (end-of-line) | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1879 (insert ", " next-node-name ", " previous-node-name ", Top") |
19110 | 1880 |
107 | 1881 (beginning-of-line) |
1882 (setq previous-node-name (texinfo-copy-node-name)) | |
19110 | 1883 |
53315
767b85819555
(texinfo-multi-file-update): create a new list of included files,
Robert J. Chassell <bob@rattlesnake.com>
parents:
52401
diff
changeset
|
1884 (setq files-with-node-lines (cdr files-with-node-lines))) |
107 | 1885 (nreverse menu-list))) |
1886 | |
1887 (defun texinfo-multi-files-insert-main-menu (menu-list) | |
1888 "Insert formatted main menu at point. | |
1889 Indents the first line of the description, if any, to the value of | |
18259 | 1890 `texinfo-column-for-description'." |
107 | 1891 |
1892 (insert "@menu\n") | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1893 (dolist (entry menu-list) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1894 ;; Every menu entry starts with a star and a space. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1895 (insert "* ") |
19110 | 1896 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1897 ;; Insert the node name (and menu entry name, if present). |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1898 (let ((node-part (car entry))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1899 (if (stringp node-part) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1900 ;; "Double colon" entry line; menu entry and node name are the same, |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1901 (insert (format "%s::" node-part)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1902 ;; "Single colon" entry line; menu entry and node name are different. |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1903 (insert (format "%s: %s." (car node-part) (cdr node-part))))) |
19110 | 1904 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1905 ;; Insert the description, if present. |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1906 (when (cdr entry) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1907 ;; Move to right place. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1908 (indent-to texinfo-column-for-description 2) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1909 ;; Insert description. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1910 (insert (format "%s" (cdr entry)))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1911 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1912 (insert "\n")) ; end this menu entry |
107 | 1913 (insert "@end menu")) |
1914 | |
1915 (defun texinfo-multi-file-master-menu-list (files-list) | |
1916 "Return master menu list from files in FILES-LIST. | |
1917 Menu entries in each file collected using `texinfo-master-menu-list'. | |
1918 | |
1919 The first file in FILES-LIST must be the outer file; the others must | |
1920 be the files included within it. A main menu must already exist." | |
1921 (save-excursion | |
1922 (let (master-menu-list) | |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1923 (dolist (file files-list) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1924 (set-buffer (find-file-noselect file)) |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1925 (message "Working on: %s " (current-buffer)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1926 (goto-char (point-min)) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1927 (setq master-menu-list |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1928 (append master-menu-list (texinfo-master-menu-list)))) |
107 | 1929 master-menu-list))) |
1930 | |
1931 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1932 ;;; The multiple-file update function |
107 | 1933 |
1934 (defun texinfo-multiple-files-update | |
75627
d20bdbec004c
(texinfo-menu-copy-old-description):
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
1935 (outer-file &optional make-master-menu update-everything) |
107 | 1936 "Update first node pointers in each file included in OUTER-FILE; |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1937 create or update the `Top' level node pointers and the main menu in |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1938 the outer file that refers to such nodes. This does not create or |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1939 update menus or pointers within the included files. |
107 | 1940 |
1941 With optional MAKE-MASTER-MENU argument (prefix arg, if interactive), | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1942 insert a master menu in OUTER-FILE in addition to creating or updating |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1943 pointers in the first @node line in each included file and creating or |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1944 updating the `Top' level node pointers of the outer file. This does |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1945 not create or update other menus and pointers within the included |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1946 files. |
107 | 1947 |
1948 With optional UPDATE-EVERYTHING argument (numeric prefix arg, if | |
1949 interactive), update all the menus and all the `Next', `Previous', and | |
1950 `Up' pointers of all the files included in OUTER-FILE before inserting | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1951 a master menu in OUTER-FILE. Also, update the `Top' level node |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1952 pointers of OUTER-FILE. |
107 | 1953 |
19110 | 1954 Notes: |
107 | 1955 |
1956 * this command does NOT save any files--you must save the | |
1957 outer file and any modified, included files. | |
1958 | |
1959 * except for the `Top' node, this command does NOT handle any | |
1960 pre-existing nodes in the outer file; hence, indices must be | |
1961 enclosed in an included file. | |
1962 | |
1963 Requirements: | |
1964 | |
1965 * each of the included files must contain exactly one highest | |
19110 | 1966 hierarchical level node, |
107 | 1967 * this highest node must be the first node in the included file, |
1968 * each highest hierarchical level node must be of the same type. | |
1969 | |
1970 Thus, normally, each included file contains one, and only one, | |
1971 chapter." | |
19110 | 1972 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
1973 (interactive (cons |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1974 (read-string |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1975 "Name of outer `include' file: " |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1976 (buffer-file-name)) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1977 (cond |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1978 ((not current-prefix-arg) '(nil nil)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1979 ((listp current-prefix-arg) '(t nil)) ; make-master-menu |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1980 ((numberp current-prefix-arg) '(t t))))) ; update-everything |
107 | 1981 |
1982 (let* ((included-file-list (texinfo-multi-file-included-list outer-file)) | |
24175
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1983 (files included-file-list) |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1984 next-node-name |
ec6c3e69f89a
(texinfo-make-menu): Make region-end a marker.
Karl Heuer <kwzh@gnu.org>
parents:
23414
diff
changeset
|
1985 previous-node-name |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1986 ;; Update the pointers and collect the names of the nodes and titles |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1987 (main-menu-list (texinfo-multi-file-update files update-everything))) |
107 | 1988 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1989 ;; Insert main menu |
107 | 1990 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1991 ;; Go to outer file |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1992 (set-buffer (find-file-noselect (car included-file-list))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1993 (if (texinfo-old-menu-p |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1994 (point-min) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1995 (save-excursion |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1996 (re-search-forward "^@include") |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1997 (beginning-of-line) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
1998 (point))) |
107 | 1999 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2000 ;; If found, leave point after word `menu' on the `@menu' line. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2001 (progn |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2002 (texinfo-incorporate-descriptions main-menu-list) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2003 ;; Delete existing menu. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2004 (beginning-of-line) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2005 (delete-region |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2006 (point) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2007 (save-excursion (re-search-forward "^@end menu") (point))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2008 ;; Insert main menu |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2009 (texinfo-multi-files-insert-main-menu main-menu-list)) |
107 | 2010 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2011 ;; Else no current menu; insert it before `@include' |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2012 (texinfo-multi-files-insert-main-menu main-menu-list)) |
107 | 2013 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2014 ;; Insert master menu |
107 | 2015 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2016 (if make-master-menu |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2017 (progn |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2018 ;; First, removing detailed part of any pre-existing master menu |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2019 (goto-char (point-min)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2020 (if (search-forward texinfo-master-menu-header nil t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2021 (progn |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2022 (goto-char (match-beginning 0)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2023 ;; Check if @detailmenu kludge is used; |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2024 ;; if so, leave point before @detailmenu. |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2025 (search-backward "\n@detailmenu" |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2026 (save-excursion (forward-line -3) (point)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2027 t) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2028 ;; Remove detailed master menu listing |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2029 (let ((end-of-detailed-menu-descriptions |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2030 (save-excursion ; beginning of end menu line |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2031 (goto-char (texinfo-menu-end)) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2032 (beginning-of-line) (forward-char -1) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2033 (point)))) |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2034 (delete-region (point) end-of-detailed-menu-descriptions)))) |
107 | 2035 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2036 ;; Create a master menu and insert it |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2037 (texinfo-insert-master-menu-list |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2038 (texinfo-multi-file-master-menu-list |
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2039 included-file-list))))) |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2040 |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2041 ;; Remove unwanted extra lines. |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2042 (save-excursion |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2043 (goto-char (point-min)) |
19110 | 2044 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2045 (re-search-forward "^@menu") |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2046 (forward-line -1) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2047 (insert "\n") ; Ensure at least one blank line. |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2048 (delete-blank-lines) |
19110 | 2049 |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2050 (re-search-forward "^@end menu") |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2051 (forward-line 1) |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2052 (insert "\n") ; Ensure at least one blank line. |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2053 (delete-blank-lines)) |
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2054 |
107 | 2055 (message "Multiple files updated.")) |
2056 | |
4028
3831300d2ecb
Fix typo re `texinfo-sequential-node-update.'
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
2057 |
40390
11e824c23fd8
Use `when', `dolist', `push', ...
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
40284
diff
changeset
|
2058 ;; Place `provide' at end of file. |
584 | 2059 (provide 'texnfo-upd) |
2060 | |
93975
1e3a407766b9
Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
79719
diff
changeset
|
2061 ;; arch-tag: d21613a5-c32f-43f4-8af4-bfb1e7455842 |
657
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
2062 ;;; texnfo-upd.el ends here |