aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2004-05-21 18:10:21 +0000
committerJuanma Barranquero2004-05-21 18:10:21 +0000
commite126900f1ef0d7fa0c3e772c7a251cf49aee81e1 (patch)
treea856b5837821f5837fc89ffbcd213f804861a0ff
parentce44846f77ec65c962b6090398b36b34ad96f9e3 (diff)
downloademacs-e126900f1ef0d7fa0c3e772c7a251cf49aee81e1.tar.gz
emacs-e126900f1ef0d7fa0c3e772c7a251cf49aee81e1.zip
(allout-chart-subtree, allout-rebullet-topic-grunt): Don't mention in the
docstring these arguments meant for internal (recursive) use only. (allout-char-spec): Comment out (it's not implemented). (allout-old-expose-topic, allout-exposure): Fix docstring and add obsolescence declaration. (allout-flatten-exposed-to-buffer, allout-indented-exposed-to-buffer): Fix typos in docstring. (my-mark-marker): Doc fix. (produce-allout-mode-map, allout-sibling-index, allout-isearch-expose) (allout-distinctive-bullet, allout-open-topic, allout-reindent-body) (allout-rebullet-heading, allout-process-exposed, allout-insert-listified) (allout-latex-verb-quote, allout-insert-latex-header) (allout-insert-latex-trailer): Make arguments match their use in docstring. (allout-primary-bullet, allout-old-style-prefixes, allout-inhibit-protection) (allout-init, allout-mode, allout-before-change-protect, allout-flag-region): Use "Emacs" instead of "emacs" in docstrings.
-rw-r--r--lisp/allout.el195
1 files changed, 96 insertions, 99 deletions
diff --git a/lisp/allout.el b/lisp/allout.el
index b2cc486df6a..903574e4ade 100644
--- a/lisp/allout.el
+++ b/lisp/allout.el
@@ -1,6 +1,6 @@
1;;; allout.el --- extensive outline mode for use alone and with other modes 1;;; allout.el --- extensive outline mode for use alone and with other modes
2 2
3;; Copyright (C) 1992, 1993, 1994, 2001, 2002 Free Software Foundation, Inc. 3;; Copyright (C) 1992, 93, 94, 2001, 02, 2004 Free Software Foundation, Inc.
4 4
5;; Author: Ken Manheimer <klm@zope.com> 5;; Author: Ken Manheimer <klm@zope.com>
6;; Maintainer: Ken Manheimer <klm@zope.com> 6;; Maintainer: Ken Manheimer <klm@zope.com>
@@ -46,7 +46,7 @@
46;; 46;;
47;; The outline menubar additions provide quick reference to many of 47;; The outline menubar additions provide quick reference to many of
48;; the features, and see the docstring of the function `allout-init' 48;; the features, and see the docstring of the function `allout-init'
49;; for instructions on priming your emacs session for automatic 49;; for instructions on priming your Emacs session for automatic
50;; activation of `allout-mode'. 50;; activation of `allout-mode'.
51;; 51;;
52;; See the docstring of the variables `allout-layout' and 52;; See the docstring of the variables `allout-layout' and
@@ -162,7 +162,7 @@ prefix, which is concluded by bullets that includes the value of this
162var and the respective allout-*-bullets-string vars. 162var and the respective allout-*-bullets-string vars.
163 163
164The value of an asterisk (`*') provides for backwards compatibility 164The value of an asterisk (`*') provides for backwards compatibility
165with the original emacs outline mode. See `allout-plain-bullets-string' 165with the original Emacs outline mode. See `allout-plain-bullets-string'
166and `allout-distinctive-bullets-string' for the range of available 166and `allout-distinctive-bullets-string' for the range of available
167bullets." 167bullets."
168 :type 'string 168 :type 'string
@@ -263,7 +263,7 @@ from regular comments that start at bol.")
263 263
264Non-nil restricts the topic creation and modification 264Non-nil restricts the topic creation and modification
265functions to asterix-padded prefixes, so they look exactly 265functions to asterix-padded prefixes, so they look exactly
266like the original emacs-outline style prefixes. 266like the original Emacs-outline style prefixes.
267 267
268Whatever the setting of this variable, both old and new style prefixes 268Whatever the setting of this variable, both old and new style prefixes
269are always respected by the topic maneuvering functions." 269are always respected by the topic maneuvering functions."
@@ -491,7 +491,7 @@ those that do not have the variable `comment-start' set. A value of
491(defcustom allout-inhibit-protection nil 491(defcustom allout-inhibit-protection nil
492 "*Non-nil disables warnings and confirmation-checks for concealed-text edits. 492 "*Non-nil disables warnings and confirmation-checks for concealed-text edits.
493 493
494Outline mode uses emacs change-triggered functions to detect unruly 494Outline mode uses Emacs change-triggered functions to detect unruly
495changes to concealed regions. Set this var non-nil to disable the 495changes to concealed regions. Set this var non-nil to disable the
496protection, potentially increasing text-entry responsiveness a bit. 496protection, potentially increasing text-entry responsiveness a bit.
497 497
@@ -507,7 +507,7 @@ behavior."
507;;;_ : Version 507;;;_ : Version
508;;;_ = allout-version 508;;;_ = allout-version
509(defvar allout-version 509(defvar allout-version
510 (let ((rcs-rev "$Revision: 1.48 $")) 510 (let ((rcs-rev "$Revision: 1.49 $"))
511 (condition-case err 511 (condition-case err
512 (save-match-data 512 (save-match-data
513 (string-match "Revision: \\([0-9]+\\.[0-9]+\\)" rcs-rev) 513 (string-match "Revision: \\([0-9]+\\.[0-9]+\\)" rcs-rev)
@@ -708,7 +708,7 @@ Works with respect to `allout-plain-bullets-string' and
708(defvar allout-mode-map nil "Keybindings for (allout) outline minor mode.") 708(defvar allout-mode-map nil "Keybindings for (allout) outline minor mode.")
709;;;_ > produce-allout-mode-map (keymap-alist &optional base-map) 709;;;_ > produce-allout-mode-map (keymap-alist &optional base-map)
710(defun produce-allout-mode-map (keymap-list &optional base-map) 710(defun produce-allout-mode-map (keymap-list &optional base-map)
711 "Produce keymap for use as allout-mode-map, from keymap-list. 711 "Produce keymap for use as allout-mode-map, from KEYMAP-LIST.
712 712
713Built on top of optional BASE-MAP, or empty sparse map if none specified. 713Built on top of optional BASE-MAP, or empty sparse map if none specified.
714See doc string for allout-keybindings-list for format of binding list." 714See doc string for allout-keybindings-list for format of binding list."
@@ -939,7 +939,7 @@ MODE is one of the following symbols:
939 - anything else \(eg, t) for auto-activation and auto-layout, without 939 - anything else \(eg, t) for auto-activation and auto-layout, without
940 any confirmation check. 940 any confirmation check.
941 941
942Use this function to setup your emacs session for automatic activation 942Use this function to setup your Emacs session for automatic activation
943of allout outline mode, contingent to the buffer-specific setting of 943of allout outline mode, contingent to the buffer-specific setting of
944the `allout-layout' variable. (See `allout-layout' and 944the `allout-layout' variable. (See `allout-layout' and
945`allout-expose-topic' docstrings for more details on auto layout). 945`allout-expose-topic' docstrings for more details on auto layout).
@@ -948,8 +948,8 @@ the `allout-layout' variable. (See `allout-layout' and
948`allout-find-file-hook' in `find-file-hook', and giving 948`allout-find-file-hook' in `find-file-hook', and giving
949`allout-auto-activation' a suitable setting. 949`allout-auto-activation' a suitable setting.
950 950
951To prime your emacs session for full auto-outline operation, include 951To prime your Emacs session for full auto-outline operation, include
952the following two lines in your emacs init file: 952the following two lines in your Emacs init file:
953 953
954\(require 'allout) 954\(require 'allout)
955\(allout-init t)" 955\(allout-init t)"
@@ -1044,7 +1044,7 @@ Below is a description of the bindings, and then explanation of
1044special `allout-mode' features and terminology. See also the outline 1044special `allout-mode' features and terminology. See also the outline
1045menubar additions for quick reference to many of the features, and see 1045menubar additions for quick reference to many of the features, and see
1046the docstring of the function `allout-init' for instructions on 1046the docstring of the function `allout-init' for instructions on
1047priming your emacs session for automatic activation of `allout-mode'. 1047priming your Emacs session for automatic activation of `allout-mode'.
1048 1048
1049 1049
1050The bindings are dictated by the `allout-keybindings-list' and 1050The bindings are dictated by the `allout-keybindings-list' and
@@ -1102,7 +1102,7 @@ C-c = p allout-flatten-exposed-to-buffer
1102 Like above 'copy-exposed', but convert topic 1102 Like above 'copy-exposed', but convert topic
1103 prefixes to section.subsection... numeric 1103 prefixes to section.subsection... numeric
1104 format. 1104 format.
1105ESC ESC (allout-init t) Setup emacs session for outline mode 1105ESC ESC (allout-init t) Setup Emacs session for outline mode
1106 auto-activation. 1106 auto-activation.
1107 1107
1108 HOT-SPOT Operation 1108 HOT-SPOT Operation
@@ -1132,7 +1132,7 @@ twice in a row to get to the hot-spot.
1132 1132
1133Topic hierarchy constituents - TOPICS and SUBTOPICS: 1133Topic hierarchy constituents - TOPICS and SUBTOPICS:
1134 1134
1135TOPIC: A basic, coherent component of an emacs outline. It can 1135TOPIC: A basic, coherent component of an Emacs outline. It can
1136 contain other topics, and it can be subsumed by other topics, 1136 contain other topics, and it can be subsumed by other topics,
1137CURRENT topic: 1137CURRENT topic:
1138 The visible topic most immediately containing the cursor. 1138 The visible topic most immediately containing the cursor.
@@ -1303,7 +1303,7 @@ OPEN: A topic that is not closed, though its offspring or body may be."
1303 ) 1303 )
1304 1304
1305 ; selective-display is the 1305 ; selective-display is the
1306 ; emacs conditional exposure 1306 ; Emacs conditional exposure
1307 ; mechanism: 1307 ; mechanism:
1308 (allout-resumptions 'selective-display '(t)) 1308 (allout-resumptions 'selective-display '(t))
1309 (if allout-inhibit-protection 1309 (if allout-inhibit-protection
@@ -1537,7 +1537,7 @@ Actually, returns prefix beginning point."
1537(defun allout-sibling-index (&optional depth) 1537(defun allout-sibling-index (&optional depth)
1538 "Item number of this prospective topic among its siblings. 1538 "Item number of this prospective topic among its siblings.
1539 1539
1540If optional arg depth is greater than current depth, then we're 1540If optional arg DEPTH is greater than current depth, then we're
1541opening a new level, and return 0. 1541opening a new level, and return 0.
1542 1542
1543If less than this depth, ascend to that depth and count..." 1543If less than this depth, ascend to that depth and count..."
@@ -1622,8 +1622,7 @@ Return the location of the beginning of the heading, or nil if not found."
1622 "Produce a location \"chart\" of subtopics of the containing topic. 1622 "Produce a location \"chart\" of subtopics of the containing topic.
1623 1623
1624Optional argument LEVELS specifies the depth \(relative to start 1624Optional argument LEVELS specifies the depth \(relative to start
1625depth) for the chart. Subsequent optional args are not for public 1625depth) for the chart.
1626use.
1627 1626
1628Charts are used to capture outline structure, so that outline altering 1627Charts are used to capture outline structure, so that outline altering
1629routines need assess the structure only once, and then use the chart 1628routines need assess the structure only once, and then use the chart
@@ -1636,9 +1635,11 @@ list containing, recursively, the charts for the respective subtopics.
1636The chart for a topics' offspring precedes the entry for the topic 1635The chart for a topics' offspring precedes the entry for the topic
1637itself. 1636itself.
1638 1637
1639The other function parameters are for internal recursion, and should 1638\(fn &optional levels)"
1640not be specified by external callers. ORIG-DEPTH is depth of topic at 1639
1641starting point, and PREV-DEPTH is depth of prior topic." 1640 ;; The other function parameters are for internal recursion, and should
1641 ;; not be specified by external callers. ORIG-DEPTH is depth of topic at
1642 ;; starting point, and PREV-DEPTH is depth of prior topic."
1642 1643
1643 (let ((original (not orig-depth)) ; `orig-depth' set only in recursion. 1644 (let ((original (not orig-depth)) ; `orig-depth' set only in recursion.
1644 chart curr-depth) 1645 chart curr-depth)
@@ -1652,7 +1653,7 @@ starting point, and PREV-DEPTH is depth of prior topic."
1652 1653
1653 ;; Loop over the current levels' siblings. Besides being more 1654 ;; Loop over the current levels' siblings. Besides being more
1654 ;; efficient than tail-recursing over a level, it avoids exceeding 1655 ;; efficient than tail-recursing over a level, it avoids exceeding
1655 ;; the typically quite constrained emacs max-lisp-eval-depth. 1656 ;; the typically quite constrained Emacs max-lisp-eval-depth.
1656 ;; 1657 ;;
1657 ;; Probably would speed things up to implement loop-based stack 1658 ;; Probably would speed things up to implement loop-based stack
1658 ;; operation rather than recursing for lower levels. Bah. 1659 ;; operation rather than recursing for lower levels. Bah.
@@ -1741,36 +1742,36 @@ start point."
1741 (setq chart (cdr chart)))) 1742 (setq chart (cdr chart))))
1742 result)) 1743 result))
1743;;;_ X allout-chart-spec (chart spec &optional exposing) 1744;;;_ X allout-chart-spec (chart spec &optional exposing)
1744(defun allout-chart-spec (chart spec &optional exposing) 1745;; (defun allout-chart-spec (chart spec &optional exposing)
1745 "Not yet \(if ever) implemented. 1746;; "Not yet \(if ever) implemented.
1746 1747
1747Produce exposure directives given topic/subtree CHART and an exposure SPEC. 1748;; Produce exposure directives given topic/subtree CHART and an exposure SPEC.
1748 1749
1749Exposure spec indicates the locations to be exposed and the prescribed 1750;; Exposure spec indicates the locations to be exposed and the prescribed
1750exposure status. Optional arg EXPOSING is an integer, with 0 1751;; exposure status. Optional arg EXPOSING is an integer, with 0
1751indicating pending concealment, anything higher indicating depth to 1752;; indicating pending concealment, anything higher indicating depth to
1752which subtopic headers should be exposed, and negative numbers 1753;; which subtopic headers should be exposed, and negative numbers
1753indicating (negative of) the depth to which subtopic headers and 1754;; indicating (negative of) the depth to which subtopic headers and
1754bodies should be exposed. 1755;; bodies should be exposed.
1755 1756
1756The produced list can have two types of entries. Bare numbers 1757;; The produced list can have two types of entries. Bare numbers
1757indicate points in the buffer where topic headers that should be 1758;; indicate points in the buffer where topic headers that should be
1758exposed reside. 1759;; exposed reside.
1759 1760
1760 - bare negative numbers indicates that the topic starting at the 1761;; - bare negative numbers indicates that the topic starting at the
1761 point which is the negative of the number should be opened, 1762;; point which is the negative of the number should be opened,
1762 including their entries. 1763;; including their entries.
1763 - bare positive values indicate that this topic header should be 1764;; - bare positive values indicate that this topic header should be
1764 opened. 1765;; opened.
1765 - Lists signify the beginning and end points of regions that should 1766;; - Lists signify the beginning and end points of regions that should
1766 be flagged, and the flag to employ. (For concealment: `\(\?r\)', and 1767;; be flagged, and the flag to employ. (For concealment: `\(\?r\)', and
1767 exposure:" 1768;; exposure:"
1768 (while spec 1769;; (while spec
1769 (cond ((listp spec) 1770;; (cond ((listp spec)
1770 ) 1771;; )
1771 ) 1772;; )
1772 (setq spec (cdr spec))) 1773;; (setq spec (cdr spec)))
1773 ) 1774;; )
1774 1775
1775;;;_ - Within Topic 1776;;;_ - Within Topic
1776;;;_ > allout-goto-prefix () 1777;;;_ > allout-goto-prefix ()
@@ -2138,7 +2139,7 @@ Changes to concealed regions are ignored while file is being written.
2138writes, like crypt and zip modes.) 2139writes, like crypt and zip modes.)
2139 2140
2140Locally bound in outline buffers to `before-change-functions', which 2141Locally bound in outline buffers to `before-change-functions', which
2141in emacs 19 is run before any change to the buffer. 2142in Emacs 19 is run before any change to the buffer.
2142 2143
2143Any functions which set [`this-command' to `undo', or which set] 2144Any functions which set [`this-command' to `undo', or which set]
2144`allout-override-protect' non-nil (as does, eg, allout-flag-chars) 2145`allout-override-protect' non-nil (as does, eg, allout-flag-chars)
@@ -2153,7 +2154,7 @@ are exempt from this restriction."
2153 ; Both beginning and end chars must 2154 ; Both beginning and end chars must
2154 ; be exposed: 2155 ; be exposed:
2155 (save-excursion (if (memq this-command '(newline open-line)) 2156 (save-excursion (if (memq this-command '(newline open-line))
2156 ;; Compensate for stupid emacs {new, 2157 ;; Compensate for stupid Emacs {new,
2157 ;; open-}line display optimization: 2158 ;; open-}line display optimization:
2158 (setq beg (1+ beg) 2159 (setq beg (1+ beg)
2159 end (1+ end))) 2160 end (1+ end)))
@@ -2165,7 +2166,7 @@ are exempt from this restriction."
2165 (save-match-data 2166 (save-match-data
2166 (if (equal this-command 'undo) 2167 (if (equal this-command 'undo)
2167 ;; Allow undo without inhibition. 2168 ;; Allow undo without inhibition.
2168 ;; - Undoing new and open-line hits stupid emacs redisplay 2169 ;; - Undoing new and open-line hits stupid Emacs redisplay
2169 ;; optimization (em 19 cmds.c, ~ line 200). 2170 ;; optimization (em 19 cmds.c, ~ line 200).
2170 ;; - Presumably, undoing what was properly protected when 2171 ;; - Presumably, undoing what was properly protected when
2171 ;; done. 2172 ;; done.
@@ -2331,7 +2332,7 @@ return to regular interpretation of self-insert characters."
2331 (let* ((this-key-num (cond 2332 (let* ((this-key-num (cond
2332 ((numberp last-command-char) 2333 ((numberp last-command-char)
2333 last-command-char) 2334 last-command-char)
2334 ;; XXX Only xemacs has characterp. 2335 ;; XXX Only XEmacs has characterp.
2335 ((and (fboundp 'characterp) 2336 ((and (fboundp 'characterp)
2336 (characterp last-command-char)) 2337 (characterp last-command-char))
2337 (char-to-int last-command-char)) 2338 (char-to-int last-command-char))
@@ -2385,7 +2386,7 @@ Called as part of `allout-post-command-business'."
2385 2386
2386;;;_ > allout-flag-region (from to flag) 2387;;;_ > allout-flag-region (from to flag)
2387(defmacro allout-flag-region (from to flag) 2388(defmacro allout-flag-region (from to flag)
2388 "Hide or show lines from FROM to TO, via emacs selective-display FLAG char. 2389 "Hide or show lines from FROM to TO, via Emacs selective-display FLAG char.
2389Ie, text following flag C-m \(carriage-return) is hidden until the 2390Ie, text following flag C-m \(carriage-return) is hidden until the
2390next C-j (newline) char. 2391next C-j (newline) char.
2391 2392
@@ -2398,7 +2399,7 @@ Returns the endpoint of the region."
2398 2399
2399;;;_ > allout-isearch-expose (mode) 2400;;;_ > allout-isearch-expose (mode)
2400(defun allout-isearch-expose (mode) 2401(defun allout-isearch-expose (mode)
2401 "Mode is either 'clear, 'start, 'continue, or 'final." 2402 "MODE is either 'clear, 'start, 'continue, or 'final."
2402 ;; allout-isearch-prior-pos encodes exposure status of prior pos: 2403 ;; allout-isearch-prior-pos encodes exposure status of prior pos:
2403 ;; (pos was-vis header-pos end-pos) 2404 ;; (pos was-vis header-pos end-pos)
2404 ;; pos - point of concern 2405 ;; pos - point of concern
@@ -2507,7 +2508,7 @@ Offer one suitable for current depth DEPTH as default."
2507 ) 2508 )
2508;;;_ > allout-distinctive-bullet (bullet) 2509;;;_ > allout-distinctive-bullet (bullet)
2509(defun allout-distinctive-bullet (bullet) 2510(defun allout-distinctive-bullet (bullet)
2510 "True if bullet is one of those on `allout-distinctive-bullets-string'." 2511 "True if BULLET is one of those on `allout-distinctive-bullets-string'."
2511 (string-match (regexp-quote bullet) allout-distinctive-bullets-string)) 2512 (string-match (regexp-quote bullet) allout-distinctive-bullets-string))
2512;;;_ > allout-numbered-type-prefix (&optional prefix) 2513;;;_ > allout-numbered-type-prefix (&optional prefix)
2513(defun allout-numbered-type-prefix (&optional prefix) 2514(defun allout-numbered-type-prefix (&optional prefix)
@@ -2679,7 +2680,7 @@ index for each successive sibling)."
2679 ) 2680 )
2680;;;_ > allout-open-topic (relative-depth &optional before use_sib_bullet) 2681;;;_ > allout-open-topic (relative-depth &optional before use_sib_bullet)
2681(defun allout-open-topic (relative-depth &optional before use_sib_bullet) 2682(defun allout-open-topic (relative-depth &optional before use_sib_bullet)
2682 "Open a new topic at depth DEPTH. 2683 "Open a new topic at depth RELATIVE-DEPTH.
2683 2684
2684New topic is situated after current one, unless optional flag BEFORE 2685New topic is situated after current one, unless optional flag BEFORE
2685is non-nil, or unless current line is complete empty (not even 2686is non-nil, or unless current line is complete empty (not even
@@ -2900,7 +2901,7 @@ Maintains outline hanging topic indentation if
2900 (do-auto-fill)))) 2901 (do-auto-fill))))
2901;;;_ > allout-reindent-body (old-depth new-depth &optional number) 2902;;;_ > allout-reindent-body (old-depth new-depth &optional number)
2902(defun allout-reindent-body (old-depth new-depth &optional number) 2903(defun allout-reindent-body (old-depth new-depth &optional number)
2903 "Reindent body lines which were indented at old-depth to new-depth. 2904 "Reindent body lines which were indented at OLD-DEPTH to NEW-DEPTH.
2904 2905
2905Optional arg NUMBER indicates numbering is being added, and it must 2906Optional arg NUMBER indicates numbering is being added, and it must
2906be accommodated. 2907be accommodated.
@@ -2974,15 +2975,13 @@ Note that refill of indented paragraphs is not done."
2974 2975
2975 "Adjust bullet of current topic prefix. 2976 "Adjust bullet of current topic prefix.
2976 2977
2977All args are optional.
2978
2979If SOLICIT is non-nil, then the choice of bullet is solicited from 2978If SOLICIT is non-nil, then the choice of bullet is solicited from
2980user. If it's a character, then that character is offered as the 2979user. If it's a character, then that character is offered as the
2981default, otherwise the one suited to the context \(according to 2980default, otherwise the one suited to the context \(according to
2982distinction or depth) is offered. If non-nil, then the 2981distinction or depth) is offered. If non-nil, then the
2983context-specific bullet is just used. 2982context-specific bullet is just used.
2984 2983
2985Second arg DEPTH forces the topic prefix to that depth, regardless 2984Second arg NEW-DEPTH forces the topic prefix to that depth, regardless
2986of the topic's current depth. 2985of the topic's current depth.
2987 2986
2988Third arg NUMBER-CONTROL can force the prefix to or away from 2987Third arg NUMBER-CONTROL can force the prefix to or away from
@@ -3095,13 +3094,13 @@ With repeat count, shift topic depth by that amount."
3095contained subtopics. See `allout-rebullet-heading' for rebulleting 3094contained subtopics. See `allout-rebullet-heading' for rebulleting
3096behavior. 3095behavior.
3097 3096
3098All arguments are optional. 3097Arg RELATIVE-DEPTH means to shift the depth of the entire
3099
3100First arg RELATIVE-DEPTH means to shift the depth of the entire
3101topic that amount. 3098topic that amount.
3102 3099
3103The rest of the args are for internal recursive use by the function 3100\(fn &optional RELATIVE-DEPTH)"
3104itself. The are STARTING-DEPTH, STARTING-POINT, and INDEX." 3101
3102 ;; All args except the first one are for internal recursive use by the
3103 ;; function itself.
3105 3104
3106 (let* ((relative-depth (or relative-depth 0)) 3105 (let* ((relative-depth (or relative-depth 0))
3107 (new-depth (allout-depth)) 3106 (new-depth (allout-depth))
@@ -3900,11 +3899,7 @@ Examples:
3900 max-pos))) 3899 max-pos)))
3901;;;_ > allout-old-expose-topic (spec &rest followers) 3900;;;_ > allout-old-expose-topic (spec &rest followers)
3902(defun allout-old-expose-topic (spec &rest followers) 3901(defun allout-old-expose-topic (spec &rest followers)
3903 3902 "Dictate wholesale exposure scheme for current topic, according to SPEC.
3904 "Deprecated. Use `allout-expose-topic' \(with different schema
3905format) instead.
3906
3907Dictate wholesale exposure scheme for current topic, according to SPEC.
3908 3903
3909SPEC is either a number or a list. Optional successive args 3904SPEC is either a number or a list. Optional successive args
3910dictate exposure for subsequent siblings of current topic. 3905dictate exposure for subsequent siblings of current topic.
@@ -3931,7 +3926,7 @@ dictates the exposure depth of the topic as a whole. Subsequent
3931elements of the list are nested SPECs, dictating the specific exposure 3926elements of the list are nested SPECs, dictating the specific exposure
3932for the corresponding offspring of the topic. 3927for the corresponding offspring of the topic.
3933 3928
3934Optional FOLLOWER arguments dictate exposure for succeeding siblings." 3929Optional FOLLOWERS arguments dictate exposure for succeeding siblings."
3935 3930
3936 (interactive "xExposure spec: ") 3931 (interactive "xExposure spec: ")
3937 (let ((depth (allout-current-depth)) 3932 (let ((depth (allout-current-depth))
@@ -3976,6 +3971,9 @@ Optional FOLLOWER arguments dictate exposure for succeeding siblings."
3976 (allout-old-expose-topic (car followers)) 3971 (allout-old-expose-topic (car followers))
3977 (setq followers (cdr followers))) 3972 (setq followers (cdr followers)))
3978 max-pos)) 3973 max-pos))
3974(make-obsolete 'allout-old-expose-topic
3975 "use `allout-expose-topic' (with different schema format) instead."
3976 "19.23")
3979;;;_ > allout-new-exposure '() 3977;;;_ > allout-new-exposure '()
3980(defmacro allout-new-exposure (&rest spec) 3978(defmacro allout-new-exposure (&rest spec)
3981 "Literal frontend for `allout-expose-topic', doesn't evaluate arguments. 3979 "Literal frontend for `allout-expose-topic', doesn't evaluate arguments.
@@ -4006,9 +4004,7 @@ Examples:
4006 (list 'allout-expose-topic (list 'quote spec)))) 4004 (list 'allout-expose-topic (list 'quote spec))))
4007;;;_ > allout-exposure '() 4005;;;_ > allout-exposure '()
4008(defmacro allout-exposure (&rest spec) 4006(defmacro allout-exposure (&rest spec)
4009 "Being deprecated - use more recent `allout-new-exposure' instead. 4007 "Literal frontend for `allout-old-expose-topic', doesn't evaluate arguments
4010
4011Literal frontend for `allout-old-expose-topic', doesn't evaluate arguments
4012and retains start position." 4008and retains start position."
4013 (list 'save-excursion 4009 (list 'save-excursion
4014 '(if (not (or (allout-goto-prefix) 4010 '(if (not (or (allout-goto-prefix)
@@ -4016,6 +4012,7 @@ and retains start position."
4016 (error "Can't find any outline topics")) 4012 (error "Can't find any outline topics"))
4017 (cons 'allout-old-expose-topic 4013 (cons 'allout-old-expose-topic
4018 (mapcar (function (lambda (x) (list 'quote x))) spec)))) 4014 (mapcar (function (lambda (x) (list 'quote x))) spec))))
4015(make-obsolete 'allout-exposure 'allout-new-exposure "19.23")
4019 4016
4020;;;_ #7 Systematic outline presentation - copying, printing, flattening 4017;;;_ #7 Systematic outline presentation - copying, printing, flattening
4021 4018
@@ -4223,12 +4220,10 @@ header and body. The elements of that list are:
4223;;;_ > allout-process-exposed (&optional func from to frombuf 4220;;;_ > allout-process-exposed (&optional func from to frombuf
4224;;; tobuf format) 4221;;; tobuf format)
4225(defun allout-process-exposed (&optional func from to frombuf tobuf 4222(defun allout-process-exposed (&optional func from to frombuf tobuf
4226 format &optional start-num) 4223 format start-num)
4227 "Map function on exposed parts of current topic; results to another buffer. 4224 "Map function on exposed parts of current topic; results to another buffer.
4228 4225
4229All args are options; default values itemized below. 4226Apply FUNC to exposed portions FROM position TO position in buffer
4230
4231Apply FUNCTION to exposed portions FROM position TO position in buffer
4232FROMBUF to buffer TOBUF. Sixth optional arg, FORMAT, designates an 4227FROMBUF to buffer TOBUF. Sixth optional arg, FORMAT, designates an
4233alternate presentation form: 4228alternate presentation form:
4234 4229
@@ -4241,7 +4236,7 @@ alternate presentation form:
4241 except for distinctive bullets. 4236 except for distinctive bullets.
4242 4237
4243Defaults: 4238Defaults:
4244 FUNCTION: `allout-insert-listified' 4239 FUNC: `allout-insert-listified'
4245 FROM: region start, if region active, else start of buffer 4240 FROM: region start, if region active, else start of buffer
4246 TO: region end, if region active, else end of buffer 4241 TO: region end, if region active, else end of buffer
4247 FROMBUF: current buffer 4242 FROMBUF: current buffer
@@ -4286,11 +4281,13 @@ Defaults:
4286(defun allout-insert-listified (listified) 4281(defun allout-insert-listified (listified)
4287 "Insert contents of listified outline portion in current buffer. 4282 "Insert contents of listified outline portion in current buffer.
4288 4283
4289Listified is a list representing each topic header and body: 4284LISTIFIED is a list representing each topic header and body:
4290 4285
4291 \`(depth prefix text)' 4286 \`(depth prefix text)'
4292 4287
4293or \`(depth prefix text bullet-plus)' 4288or
4289
4290 \`(depth prefix text bullet-plus)'
4294 4291
4295If `bullet-plus' is specified, it is inserted just after the entire prefix." 4292If `bullet-plus' is specified, it is inserted just after the entire prefix."
4296 (setq listified (cdr listified)) 4293 (setq listified (cdr listified))
@@ -4356,14 +4353,14 @@ alternate presentation format for the outline:
4356(defun allout-flatten-exposed-to-buffer (&optional arg tobuf) 4353(defun allout-flatten-exposed-to-buffer (&optional arg tobuf)
4357 "Present numeric outline of outline's exposed portions in another buffer. 4354 "Present numeric outline of outline's exposed portions in another buffer.
4358 4355
4359The resulting outline is not compatable with outline mode - use 4356The resulting outline is not compatible with outline mode - use
4360`allout-copy-exposed-to-buffer' if you want that. 4357`allout-copy-exposed-to-buffer' if you want that.
4361 4358
4362Use `allout-indented-exposed-to-buffer' for indented presentation. 4359Use `allout-indented-exposed-to-buffer' for indented presentation.
4363 4360
4364With repeat count, copy the exposed portions of only current topic. 4361With repeat count, copy the exposed portions of only current topic.
4365 4362
4366Other buffer has current buffers name with \" exposed\" appended to 4363Other buffer has current buffer's name with \" exposed\" appended to
4367it, unless optional second arg TOBUF is specified, in which case it is 4364it, unless optional second arg TOBUF is specified, in which case it is
4368used verbatim." 4365used verbatim."
4369 (interactive "P") 4366 (interactive "P")
@@ -4372,22 +4369,22 @@ used verbatim."
4372(defun allout-indented-exposed-to-buffer (&optional arg tobuf) 4369(defun allout-indented-exposed-to-buffer (&optional arg tobuf)
4373 "Present indented outline of outline's exposed portions in another buffer. 4370 "Present indented outline of outline's exposed portions in another buffer.
4374 4371
4375The resulting outline is not compatable with outline mode - use 4372The resulting outline is not compatible with outline mode - use
4376`allout-copy-exposed-to-buffer' if you want that. 4373`allout-copy-exposed-to-buffer' if you want that.
4377 4374
4378Use `allout-flatten-exposed-to-buffer' for numeric sectional presentation. 4375Use `allout-flatten-exposed-to-buffer' for numeric sectional presentation.
4379 4376
4380With repeat count, copy the exposed portions of only current topic. 4377With repeat count, copy the exposed portions of only current topic.
4381 4378
4382Other buffer has current buffers name with \" exposed\" appended to 4379Other buffer has current buffer's name with \" exposed\" appended to
4383it, unless optional second arg TOBUF is specified, in which case it is 4380it, unless optional second arg TOBUF is specified, in which case it is
4384used verbatim." 4381used verbatim."
4385 (interactive "P") 4382 (interactive "P")
4386 (allout-copy-exposed-to-buffer arg tobuf 'indent)) 4383 (allout-copy-exposed-to-buffer arg tobuf 'indent))
4387 4384
4388;;;_ - LaTeX formatting 4385;;;_ - LaTeX formatting
4389;;;_ > allout-latex-verb-quote (str &optional flow) 4386;;;_ > allout-latex-verb-quote (string &optional flow)
4390(defun allout-latex-verb-quote (str &optional flow) 4387(defun allout-latex-verb-quote (string &optional flow)
4391 "Return copy of STRING for literal reproduction across latex processing. 4388 "Return copy of STRING for literal reproduction across latex processing.
4392Expresses the original characters \(including carriage returns) of the 4389Expresses the original characters \(including carriage returns) of the
4393string across latex processing." 4390string across latex processing."
@@ -4397,7 +4394,7 @@ string across latex processing."
4397 (concat "\\char" (number-to-string char) "{}")) 4394 (concat "\\char" (number-to-string char) "{}"))
4398 ((= char ?\n) "\\\\") 4395 ((= char ?\n) "\\\\")
4399 (t (char-to-string char))))) 4396 (t (char-to-string char)))))
4400 str 4397 string
4401 "")) 4398 ""))
4402;;;_ > allout-latex-verbatim-quote-curr-line () 4399;;;_ > allout-latex-verbatim-quote-curr-line ()
4403(defun allout-latex-verbatim-quote-curr-line () 4400(defun allout-latex-verbatim-quote-curr-line ()
@@ -4418,12 +4415,12 @@ environment. Leaves point at the end of the line."
4418 (insert "\\") 4415 (insert "\\")
4419 (setq end (1+ end)) 4416 (setq end (1+ end))
4420 (goto-char (1+ (match-end 0)))))) 4417 (goto-char (1+ (match-end 0))))))
4421;;;_ > allout-insert-latex-header (buf) 4418;;;_ > allout-insert-latex-header (buffer)
4422(defun allout-insert-latex-header (buf) 4419(defun allout-insert-latex-header (buffer)
4423 "Insert initial latex commands at point in BUFFER." 4420 "Insert initial latex commands at point in BUFFER."
4424 ;; Much of this is being derived from the stuff in appendix of E in 4421 ;; Much of this is being derived from the stuff in appendix of E in
4425 ;; the TeXBook, pg 421. 4422 ;; the TeXBook, pg 421.
4426 (set-buffer buf) 4423 (set-buffer buffer)
4427 (let ((doc-style (format "\n\\documentstyle{%s}\n" 4424 (let ((doc-style (format "\n\\documentstyle{%s}\n"
4428 "report")) 4425 "report"))
4429 (page-numbering (if allout-number-pages 4426 (page-numbering (if allout-number-pages
@@ -4492,10 +4489,10 @@ environment. Leaves point at the end of the line."
4492 hoffset 4489 hoffset
4493 vspace) 4490 vspace)
4494 ))) 4491 )))
4495;;;_ > allout-insert-latex-trailer (buf) 4492;;;_ > allout-insert-latex-trailer (buffer)
4496(defun allout-insert-latex-trailer (buf) 4493(defun allout-insert-latex-trailer (buffer)
4497 "Insert concluding latex commands at point in BUFFER." 4494 "Insert concluding latex commands at point in BUFFER."
4498 (set-buffer buf) 4495 (set-buffer buffer)
4499 (insert "\n\\end{document}\n")) 4496 (insert "\n\\end{document}\n"))
4500;;;_ > allout-latexify-one-item (depth prefix bullet text) 4497;;;_ > allout-latexify-one-item (depth prefix bullet text)
4501(defun allout-latexify-one-item (depth prefix bullet text) 4498(defun allout-latexify-one-item (depth prefix bullet text)
@@ -4706,9 +4703,9 @@ function. If HOOK is void, it is first set to nil."
4706 (cons function (symbol-value hook))))))) 4703 (cons function (symbol-value hook)))))))
4707;;;_ : my-mark-marker to accommodate divergent emacsen: 4704;;;_ : my-mark-marker to accommodate divergent emacsen:
4708(defun my-mark-marker (&optional force buffer) 4705(defun my-mark-marker (&optional force buffer)
4709 "Accommodate the different signature for mark-marker across emacsen. 4706 "Accommodate the different signature for mark-marker across Emacsen.
4710 4707
4711GNU XEmacs takes two optional args, while mainline GNU Emacs does not, 4708XEmacs takes two optional args, while GNU Emacs does not,
4712so pass them along when appropriate." 4709so pass them along when appropriate."
4713 (if (featurep 'xemacs) 4710 (if (featurep 'xemacs)
4714 (mark-marker force buffer) 4711 (mark-marker force buffer)