aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKarl Heuer1996-01-04 23:26:20 +0000
committerKarl Heuer1996-01-04 23:26:20 +0000
commita0776d6b0639a6c1ade1241fddd21150b919db2e (patch)
tree689519cf9dec47c0ffa1c38ae733e934ce9bf73f
parent3746aa5590dd9cd218746c5482db3b236cb3c042 (diff)
downloademacs-a0776d6b0639a6c1ade1241fddd21150b919db2e.tar.gz
emacs-a0776d6b0639a6c1ade1241fddd21150b919db2e.zip
(outline-primary-bullet, outline-numbered-bullet,
outline-override-protect, outline-explicitly-deactivated, outline-init, outline-chart-subtree, outline-chart-spec, outline-make-topic-prefix, outline-open-topic, outline-reindent-body, outline-yank-processing, outline-yank, outlineify-sticky): Doc fix.
-rw-r--r--lisp/allout.el40
1 files changed, 20 insertions, 20 deletions
diff --git a/lisp/allout.el b/lisp/allout.el
index 0da86f6a3a4..5d47a15fb9f 100644
--- a/lisp/allout.el
+++ b/lisp/allout.el
@@ -35,7 +35,7 @@
35;; 35;;
36;; It also includes such things as topic-oriented repositioning, cut, and 36;; It also includes such things as topic-oriented repositioning, cut, and
37;; paste; integral outline exposure-layout; incremental search with 37;; paste; integral outline exposure-layout; incremental search with
38;; dynamic exposure/conceament of concealed text; automatic topic-number 38;; dynamic exposure/concealment of concealed text; automatic topic-number
39;; maintenance; and many other features. 39;; maintenance; and many other features.
40;; 40;;
41;; See the docstring of the variables `outline-layout' and 41;; See the docstring of the variables `outline-layout' and
@@ -139,7 +139,7 @@ Outline topic header lines are identified by a leading topic header
139prefix, which is concluded by bullets that includes the value of this 139prefix, which is concluded by bullets that includes the value of this
140var and the respective outline-*-bullets-string vars. 140var and the respective outline-*-bullets-string vars.
141 141
142The value of an asterisk ('*') provides for backwards compatability 142The value of an asterisk ('*') provides for backwards compatibility
143with the original emacs outline mode. See outline-plain-bullets-string 143with the original emacs outline mode. See outline-plain-bullets-string
144and outline-distinctive-bullets-string for the range of available 144and outline-distinctive-bullets-string for the range of available
145bullets.") 145bullets.")
@@ -271,10 +271,10 @@ is non-nil.")
271(defvar outline-numbered-bullet "#" 271(defvar outline-numbered-bullet "#"
272 "*String designating bullet of topics that have auto-numbering; nil for none. 272 "*String designating bullet of topics that have auto-numbering; nil for none.
273 273
274Topics having this bullet have automatic maintainence of a sibling 274Topics having this bullet have automatic maintenance of a sibling
275sequence-number tacked on, just after the bullet. Conventionally set 275sequence-number tacked on, just after the bullet. Conventionally set
276to \"#\", you can set it to a bullet of your choice. A nil value 276to \"#\", you can set it to a bullet of your choice. A nil value
277disables numbering maintainence.") 277disables numbering maintenance.")
278(make-variable-buffer-local 'outline-numbered-bullet) 278(make-variable-buffer-local 'outline-numbered-bullet)
279;;;_ = outline-file-xref-bullet 279;;;_ = outline-file-xref-bullet
280(defvar outline-file-xref-bullet "@" 280(defvar outline-file-xref-bullet "@"
@@ -714,7 +714,7 @@ functions.")
714 "Used in outline-mode for regulate of concealed-text protection mechanism. 714 "Used in outline-mode for regulate of concealed-text protection mechanism.
715 715
716Allout outline mode regulates alteration of concealed text to protect 716Allout outline mode regulates alteration of concealed text to protect
717against inadvertant, unnoticed changes. This is for use by specific, 717against inadvertent, unnoticed changes. This is for use by specific,
718native outline functions to temporarily override that protection. 718native outline functions to temporarily override that protection.
719It's automatically reset to nil after every buffer modification.") 719It's automatically reset to nil after every buffer modification.")
720(make-variable-buffer-local 'outline-override-protect) 720(make-variable-buffer-local 'outline-override-protect)
@@ -754,7 +754,7 @@ protection knows to keep inactive during file write."
754 'outline-mode) 754 'outline-mode)
755;;;_ = outline-explicitly-deactivated 755;;;_ = outline-explicitly-deactivated
756(defvar outline-explicitly-deactivated nil 756(defvar outline-explicitly-deactivated nil
757 "Outline-mode was last deliberately deactived. 757 "Outline-mode was last deliberately deactivated.
758So outline-post-command-business should not reactivate it...") 758So outline-post-command-business should not reactivate it...")
759(make-variable-buffer-local 'outline-explicitly-deactivated) 759(make-variable-buffer-local 'outline-explicitly-deactivated)
760;;;_ > outline-init (&optional mode) 760;;;_ > outline-init (&optional mode)
@@ -766,7 +766,7 @@ MODE is one of the following symbols:
766 - nil \(or no argument) deactivate auto-activation/layou; 766 - nil \(or no argument) deactivate auto-activation/layou;
767 - 'activate', enable auto-activation only; 767 - 'activate', enable auto-activation only;
768 - 'ask', enable auto-activation, and enable auto-layout but with 768 - 'ask', enable auto-activation, and enable auto-layout but with
769 confirmation for layout operation solicitated from user each time; 769 confirmation for layout operation solicited from user each time;
770 - 'report', just report and return the current auto-activation state; 770 - 'report', just report and return the current auto-activation state;
771 - anything else \(eg, t) for auto-activation and auto-layout, without 771 - anything else \(eg, t) for auto-activation and auto-layout, without
772 any confirmation check. 772 any confirmation check.
@@ -848,7 +848,7 @@ which is organized in outline structure.\)
848 848
849It also includes such things as topic-oriented repositioning, cut, and 849It also includes such things as topic-oriented repositioning, cut, and
850paste; integral outline exposure-layout; incremental search with 850paste; integral outline exposure-layout; incremental search with
851dynamic exposure/conceament of concealed text; automatic topic-number 851dynamic exposure/concealment of concealed text; automatic topic-number
852maintenance; and many other features. 852maintenance; and many other features.
853 853
854See the docstring of the variable `outline-init' for instructions on 854See the docstring of the variable `outline-init' for instructions on
@@ -1017,7 +1017,7 @@ OPEN: A topic that is not closed, though its' offspring or body may be."
1017 (toggle (and toggle 1017 (toggle (and toggle
1018 (or (and (listp toggle)(car toggle)) 1018 (or (and (listp toggle)(car toggle))
1019 toggle))) 1019 toggle)))
1020 ; Activation specficially demanded? 1020 ; Activation specifically demanded?
1021 (explicit-activation (or 1021 (explicit-activation (or
1022 ;; 1022 ;;
1023 (and toggle 1023 (and toggle
@@ -1408,7 +1408,7 @@ Return the location of the beginning of the heading, or nil if not found."
1408(defun outline-chart-subtree (&optional levels orig-depth prev-depth) 1408(defun outline-chart-subtree (&optional levels orig-depth prev-depth)
1409 "Produce a location \"chart\" of subtopics of the containing topic. 1409 "Produce a location \"chart\" of subtopics of the containing topic.
1410 1410
1411Optional argument LEVELS specifies the depth \(releative to start 1411Optional argument LEVELS specifies the depth \(relative to start
1412depth\) for the chart. Subsequent optional args are not for public 1412depth\) for the chart. Subsequent optional args are not for public
1413use. 1413use.
1414 1414
@@ -1546,7 +1546,7 @@ exposed reside.
1546 point which is the negative of the number should be opened, 1546 point which is the negative of the number should be opened,
1547 including their entries. 1547 including their entries.
1548 - bare positive values indicate that this topic header should be 1548 - bare positive values indicate that this topic header should be
1549 openned. 1549 opened.
1550 - Lists signify the beginning and end points of regions that should 1550 - Lists signify the beginning and end points of regions that should
1551 be flagged, and the flag to employ. (For concealment: '\(\?r\)', and 1551 be flagged, and the flag to employ. (For concealment: '\(\?r\)', and
1552 exposure:" 1552 exposure:"
@@ -2235,7 +2235,7 @@ bullet. Non-nil NUMBER-CONTROL and non-nil, non-number INDEX means
2235that the index for the numbered prefix will be derived, by counting 2235that the index for the numbered prefix will be derived, by counting
2236siblings back to start of level. If INDEX is a number, then that 2236siblings back to start of level. If INDEX is a number, then that
2237number is used as the index for the numbered prefix (allowing, eg, 2237number is used as the index for the numbered prefix (allowing, eg,
2238sequential renumbering to not requre this function counting back the 2238sequential renumbering to not require this function counting back the
2239index for each successive sibling)." 2239index for each successive sibling)."
2240;;;_ . Code: 2240;;;_ . Code:
2241 ;; The options are ordered in likely frequence of use, most common 2241 ;; The options are ordered in likely frequence of use, most common
@@ -2358,7 +2358,7 @@ Nuances:
2358- Creation of sibling or nested topics is with respect to the topic 2358- Creation of sibling or nested topics is with respect to the topic
2359 you're starting from, even when creating backwards. This way you 2359 you're starting from, even when creating backwards. This way you
2360 can easily create a sibling in front of the current topic without 2360 can easily create a sibling in front of the current topic without
2361 having to go to its preceeding sibling, and then open forward 2361 having to go to its preceding sibling, and then open forward
2362 from there." 2362 from there."
2363 2363
2364 (let* ((depth (+ (outline-current-depth) relative-depth)) 2364 (let* ((depth (+ (outline-current-depth) relative-depth))
@@ -2392,7 +2392,7 @@ Nuances:
2392 (setq dbl-space ; Determine double space action: 2392 (setq dbl-space ; Determine double space action:
2393 (or (and (<= relative-depth 0) ; not descending; 2393 (or (and (<= relative-depth 0) ; not descending;
2394 (save-excursion 2394 (save-excursion
2395 ;; at b-o-b or preceeded by a blank line? 2395 ;; at b-o-b or preceded by a blank line?
2396 (or (> 0 (forward-line -1)) 2396 (or (> 0 (forward-line -1))
2397 (looking-at "^\\s-*$") 2397 (looking-at "^\\s-*$")
2398 (bobp))) 2398 (bobp)))
@@ -2484,7 +2484,7 @@ Nuances:
2484;;;_ . open-topic contingencies 2484;;;_ . open-topic contingencies
2485;;;_ ; base topic - one from which open was issued 2485;;;_ ; base topic - one from which open was issued
2486;;;_ , beginning char 2486;;;_ , beginning char
2487;;;_ , amount of space before will be used, unless openning in place 2487;;;_ , amount of space before will be used, unless opening in place
2488;;;_ , end char will be used, unless opening before (and it still may) 2488;;;_ , end char will be used, unless opening before (and it still may)
2489;;;_ ; absolute depth of new topic 2489;;;_ ; absolute depth of new topic
2490;;;_ ! insert in place - overrides most stuff 2490;;;_ ! insert in place - overrides most stuff
@@ -2549,7 +2549,7 @@ Maintains outline hanging topic indentation if
2549 "Reindent body lines which were indented at old-depth to new-depth. 2549 "Reindent body lines which were indented at old-depth to new-depth.
2550 2550
2551Optional arg NUMBER indicates numbering is being added, and it must 2551Optional arg NUMBER indicates numbering is being added, and it must
2552be accomodated. 2552be accommodated.
2553 2553
2554Note that refill of indented paragraphs is not done." 2554Note that refill of indented paragraphs is not done."
2555 2555
@@ -2937,7 +2937,7 @@ Does depth adjustment of yanked topics, when:
29372 it is being yanked at the end of a line which consists of only a valid 29372 it is being yanked at the end of a line which consists of only a valid
2938 topic prefix. 2938 topic prefix.
2939 2939
2940Also, adjusts numbering of subsequent siblings when appropropriate. 2940Also, adjusts numbering of subsequent siblings when appropriate.
2941 2941
2942Depth adjustment alters the depth of all the topics being yanked 2942Depth adjustment alters the depth of all the topics being yanked
2943the amount it takes to make the first topic have the depth of the 2943the amount it takes to make the first topic have the depth of the
@@ -3057,7 +3057,7 @@ however, are left exactly like normal, non-outline-specific yanks."
3057(defun outline-yank (&optional arg) 3057(defun outline-yank (&optional arg)
3058 "Outline-mode yank, with depth and numbering adjustment of yanked topics. 3058 "Outline-mode yank, with depth and numbering adjustment of yanked topics.
3059 3059
3060Non-topic yanks work no differntly than normal yanks. 3060Non-topic yanks work no differently than normal yanks.
3061 3061
3062If a topic is being yanked into a bare topic prefix, the depth of the 3062If a topic is being yanked into a bare topic prefix, the depth of the
3063yanked topic is adjusted to the depth of the topic prefix. 3063yanked topic is adjusted to the depth of the topic prefix.
@@ -3076,7 +3076,7 @@ at the end (and vice-versa with the mark). Non-adjusted yanks,
3076however, (ones that don't qualify for adjustment) are handled 3076however, (ones that don't qualify for adjustment) are handled
3077exactly like normal yanks. 3077exactly like normal yanks.
3078 3078
3079Numbering of yanked topics, and the succesive siblings at the depth 3079Numbering of yanked topics, and the successive siblings at the depth
3080into which they're being yanked, is adjusted. 3080into which they're being yanked, is adjusted.
3081 3081
3082Outline-yank-pop works with outline-yank just like normal yank-pop 3082Outline-yank-pop works with outline-yank just like normal yank-pop
@@ -4197,7 +4197,7 @@ With repeat count, copy the exposed portions of entire buffer."
4197;; outlinify-sticky is correct spelling; provide this alias for sticklers: 4197;; outlinify-sticky is correct spelling; provide this alias for sticklers:
4198(defalias 'outlinify-sticky 'outlineify-sticky) 4198(defalias 'outlinify-sticky 'outlineify-sticky)
4199(defun outlineify-sticky (&optional arg) 4199(defun outlineify-sticky (&optional arg)
4200 "Activate outline mode and establish file var so it is started subseqently. 4200 "Activate outline mode and establish file var so it is started subsequently.
4201 4201
4202See doc-string for `outline-layout' and `outline-init' for details on 4202See doc-string for `outline-layout' and `outline-init' for details on
4203setup for auto-startup." 4203setup for auto-startup."