annotate lisp/tutorial.el @ 82424:83b5777829ff

Delete all bugs - see the copy on the release branch.
author Glenn Morris <rgm@gnu.org>
date Fri, 17 Aug 2007 07:18:47 +0000
parents b98604865ea0
children 10439b0bb602
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
1 ;;; tutorial.el --- tutorial for Emacs
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
2
75347
e3694f1cb928 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 75162
diff changeset
3 ;; Copyright (C) 2006, 2007 Free Software Foundation, Inc.
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
4
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
5 ;; Maintainer: FSF
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
6 ;; Keywords: help, internal
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
7
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
9
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
78236
9355f9b7bbff Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 78136
diff changeset
12 ;; the Free Software Foundation; either version 3, or (at your option)
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
13 ;; any later version.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
14
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
18 ;; GNU General Public License for more details.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
19
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
23 ;; Boston, MA 02110-1301, USA.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
24
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
25 ;;; Commentary:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
26
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
27 ;; Code for running the Emacs tutorial.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
28
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
29 ;;; History:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
30
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
31 ;; File was created 2006-09.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
32
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
33 ;;; Code:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
34
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
35 (require 'help-mode) ;; for function help-buffer
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
36
74100
9b8e3f194cc1 (tutorial-warning-face): New face.
Chong Yidong <cyd@stupidchicken.com>
parents: 73567
diff changeset
37 (defface tutorial-warning-face
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
38 '((t :inherit font-lock-warning-face))
74100
9b8e3f194cc1 (tutorial-warning-face): New face.
Chong Yidong <cyd@stupidchicken.com>
parents: 73567
diff changeset
39 "Face used to highlight warnings in the tutorial."
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
40 :group 'help)
74100
9b8e3f194cc1 (tutorial-warning-face): New face.
Chong Yidong <cyd@stupidchicken.com>
parents: 73567
diff changeset
41
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
42 (defvar tutorial--point-before-chkeys 0
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
43 "Point before display of key changes.")
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
44 (make-variable-buffer-local 'tutorial--point-before-chkeys)
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
45
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
46 (defvar tutorial--point-after-chkeys 0
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
47 "Point after display of key changes.")
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
48 (make-variable-buffer-local 'tutorial--point-after-chkeys)
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
49
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
50 (defvar tutorial--lang nil
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
51 "Tutorial language.")
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
52 (make-variable-buffer-local 'tutorial--lang)
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
53
73552
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
54 (defun tutorial--describe-nonstandard-key (value)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
55 "Give more information about a changed key binding.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
56 This is used in `help-with-tutorial'. The information includes
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
57 the key sequence that no longer has a default binding, the
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
58 default binding and the current binding. It also tells in what
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
59 keymap the new binding has been done and how to access the
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
60 function in the default binding from the keyboard.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
61
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
62 For `cua-mode' key bindings that try to combine CUA key bindings
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
63 with default Emacs bindings information about this is shown.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
64
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
65 VALUE should have either of these formats:
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
66
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
67 \(cua-mode)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
68 \(current-binding KEY-FUN DEF-FUN KEY WHERE)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
69
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
70 Where
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
71 KEY is a key sequence whose standard binding has been changed
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
72 KEY-FUN is the actual binding for KEY
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
73 DEF-FUN is the standard binding of KEY
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
74 WHERE is a text describing the key sequences to which DEF-FUN is
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
75 bound now (or, if it is remapped, a key sequence
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
76 for the function it is remapped to)"
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
77 (with-output-to-temp-buffer (help-buffer)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
78 (help-setup-xref (list #'tutorial--describe-nonstandard-key value)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
79 (interactive-p))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
80 (with-current-buffer (help-buffer)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
81 (insert
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
82 "Your Emacs customizations override the default binding for this key:"
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
83 "\n\n")
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
84 (let ((inhibit-read-only t))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
85 (cond
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
86 ((eq (car value) 'cua-mode)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
87 (insert
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
88 "CUA mode is enabled.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
89
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
90 When CUA mode is enabled, you can use C-z, C-x, C-c, and C-v to
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
91 undo, cut, copy, and paste in addition to the normal Emacs
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
92 bindings. The C-x and C-c keys only do cut and copy when the
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
93 region is active, so in most cases, they do not conflict with the
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
94 normal function of these prefix keys.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
95
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
96 If you really need to perform a command which starts with one of
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
97 the prefix keys even when the region is active, you have three
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
98 options:
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
99 - press the prefix key twice very quickly (within 0.2 seconds),
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
100 - press the prefix key and the following key within 0.2 seconds, or
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
101 - use the SHIFT key with the prefix key, i.e. C-S-x or C-S-c."))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
102 ((eq (car value) 'current-binding)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
103 (let ((cb (nth 1 value))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
104 (db (nth 2 value))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
105 (key (nth 3 value))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
106 (where (nth 4 value))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
107 map
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
108 (maps (current-active-maps))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
109 mapsym)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
110 ;; Look at the currently active keymaps and try to find
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
111 ;; first the keymap where the current binding occurs:
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
112 (while maps
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
113 (let* ((m (car maps))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
114 (mb (lookup-key m key t)))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
115 (setq maps (cdr maps))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
116 (when (eq mb cb)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
117 (setq map m)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
118 (setq maps nil))))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
119 ;; Now, if a keymap was found we must found the symbol
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
120 ;; name for it to display to the user. This can not
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
121 ;; always be found since all keymaps does not have a
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
122 ;; symbol pointing to them, but here they should have
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
123 ;; that:
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
124 (when map
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
125 (mapatoms (lambda (s)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
126 (and
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
127 ;; If not already found
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
128 (not mapsym)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
129 ;; and if s is a keymap
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
130 (and (boundp s)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
131 (keymapp (symbol-value s)))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
132 ;; and not the local symbol map
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
133 (not (eq s 'map))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
134 ;; and the value of s is map
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
135 (eq map (symbol-value s))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
136 ;; then save this value in mapsym
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
137 (setq mapsym s)))))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
138 (insert "The default Emacs binding for the key "
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
139 (key-description key)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
140 " is the command `")
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
141 (insert (format "%s" db))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
142 (insert "'. "
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
143 "However, your customizations have rebound it to the command `")
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
144 (insert (format "%s" cb))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
145 (insert "'.")
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
146 (when mapsym
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
147 (insert " (For the more advanced user:"
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
148 " This binding is in the keymap `"
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
149 (format "%s" mapsym)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
150 "'.)"))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
151 (if (string= where "")
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
152 (unless (keymapp db)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
153 (insert "\n\nYou can use M-x "
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
154 (format "%s" db)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
155 " RET instead."))
75069
49625651e125 (tutorial--describe-nonstandard-key): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 74797
diff changeset
156 (insert "\n\nWith your current key bindings"
76210
ef62cc69bfdd (tutorial--describe-nonstandard-key): Tweak text in the menus case.
Glenn Morris <rgm@gnu.org>
parents: 75557
diff changeset
157 " you can use "
81215
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
158 (if (string-match "^the .*menus?$" where)
76210
ef62cc69bfdd (tutorial--describe-nonstandard-key): Tweak text in the menus case.
Glenn Morris <rgm@gnu.org>
parents: 75557
diff changeset
159 ""
81215
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
160 "the key")
73552
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
161 where
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
162 " to get the function `"
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
163 (format "%s" db)
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
164 "'.")))
73552
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
165 (fill-region (point-min) (point)))))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
166 (print-help-return-message))))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
167
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
168 (defun tutorial--sort-keys (left right)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
169 "Sort predicate for use with `tutorial--default-keys'.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
170 This is a predicate function to `sort'.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
171
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
172 The sorting is for presentation purpose only and is done on the
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
173 key sequence.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
174
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
175 LEFT and RIGHT are the elements to compare."
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
176 (let ((x (append (cadr left) nil))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
177 (y (append (cadr right) nil)))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
178 ;; Skip the front part of the key sequences if they are equal:
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
179 (while (and x y
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
180 (listp x) (listp y)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
181 (equal (car x) (car y)))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
182 (setq x (cdr x))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
183 (setq y (cdr y)))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
184 ;; Try to make a comparision that is useful for presentation (this
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
185 ;; could be made nicer perhaps):
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
186 (let ((cx (car x))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
187 (cy (car y)))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
188 ;;(message "x=%s, y=%s;;;; cx=%s, cy=%s" x y cx cy)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
189 (cond
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
190 ;; Lists? Then call this again
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
191 ((and cx cy
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
192 (listp cx)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
193 (listp cy))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
194 (tutorial--sort-keys cx cy))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
195 ;; Are both numbers? Then just compare them
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
196 ((and (wholenump cx)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
197 (wholenump cy))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
198 (> cx cy))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
199 ;; Is one of them a number? Let that be bigger then.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
200 ((wholenump cx)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
201 t)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
202 ((wholenump cy)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
203 nil)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
204 ;; Are both symbols? Compare the names then.
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
205 ((and (symbolp cx)
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
206 (symbolp cy))
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
207 (string< (symbol-name cy)
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
208 (symbol-name cx)))))))
73552
7063b0e05658 Fix last fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 73551
diff changeset
209
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
210 (defconst tutorial--default-keys
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
211 ;; On window system, `suspend-emacs' is replaced in the default
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
212 ;; keymap
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
213 (let* ((suspend-emacs (if window-system
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
214 'iconify-or-deiconify-frame
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
215 'suspend-emacs))
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
216 (default-keys
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
217 `((ESC-prefix [27])
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
218 (Control-X-prefix [?\C-x])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
219 (mode-specific-command-prefix [?\C-c])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
220 (save-buffers-kill-emacs [?\C-x ?\C-c])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
221
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
222 ;; * SUMMARY
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
223 (scroll-up [?\C-v])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
224 (scroll-down [?\M-v])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
225 (recenter [?\C-l])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
226
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
227 ;; * BASIC CURSOR CONTROL
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
228 (forward-char [?\C-f])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
229 (backward-char [?\C-b])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
230 (forward-word [?\M-f])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
231 (backward-word [?\M-b])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
232 (next-line [?\C-n])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
233 (previous-line [?\C-p])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
234 (move-beginning-of-line [?\C-a])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
235 (move-end-of-line [?\C-e])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
236 (backward-sentence [?\M-a])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
237 (forward-sentence [?\M-e])
74113
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
238 (newline "\r")
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
239 (beginning-of-buffer [?\M-<])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
240 (end-of-buffer [?\M->])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
241 (universal-argument [?\C-u])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
242
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
243 ;; * WHEN EMACS IS HUNG
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
244 (keyboard-quit [?\C-g])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
245
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
246 ;; * DISABLED COMMANDS
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
247 (downcase-region [?\C-x ?\C-l])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
248
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
249 ;; * WINDOWS
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
250 (delete-other-windows [?\C-x ?1])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
251 ;; C-u 0 C-l
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
252 ;; Type CONTROL-h k CONTROL-f.
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
253
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
254 ;; * INSERTING AND DELETING
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
255 ;; C-u 8 * to insert ********.
74113
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
256 (delete-backward-char "\d")
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
257 (delete-char [?\C-d])
75471
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
258 (backward-kill-word [?\M-\d])
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
259 (kill-word [?\M-d])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
260 (kill-line [?\C-k])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
261 (kill-sentence [?\M-k])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
262 (set-mark-command [?\C-@])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
263 (set-mark-command [?\C- ])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
264 (kill-region [?\C-w])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
265 (yank [?\C-y])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
266 (yank-pop [?\M-y])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
267
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
268 ;; * UNDO
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
269 (advertised-undo [?\C-x ?u])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
270 (advertised-undo [?\C-x ?u])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
271
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
272 ;; * FILES
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
273 (find-file [?\C-x ?\C-f])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
274 (save-buffer [?\C-x ?\C-s])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
275
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
276 ;; * BUFFERS
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
277 (list-buffers [?\C-x ?\C-b])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
278 (switch-to-buffer [?\C-x ?b])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
279 (save-some-buffers [?\C-x ?s])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
280
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
281 ;; * EXTENDING THE COMMAND SET
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
282 ;; C-x Character eXtend. Followed by one character.
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
283 (execute-extended-command [?\M-x])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
284 ;; C-x C-f Find file
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
285 ;; C-x C-s Save file
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
286 ;; C-x s Save some buffers
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
287 ;; C-x C-b List buffers
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
288 ;; C-x b Switch buffer
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
289 ;; C-x C-c Quit Emacs
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
290 ;; C-x 1 Delete all but one window
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
291 ;; C-x u Undo
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
292
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
293 ;; * MODE LINE
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
294 (describe-mode [?\C-h ?m])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
295 (set-fill-column [?\C-x ?f])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
296 (fill-paragraph [?\M-q])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
297
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
298 ;; * SEARCHING
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
299 (isearch-forward [?\C-s])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
300 (isearch-backward [?\C-r])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
301
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
302 ;; * MULTIPLE WINDOWS
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
303 (split-window-vertically [?\C-x ?2])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
304 (scroll-other-window [?\C-\M-v])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
305 (other-window [?\C-x ?o])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
306 (find-file-other-window [?\C-x ?4 ?\C-f])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
307
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
308 ;; * RECURSIVE EDITING LEVELS
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
309 (keyboard-escape-quit [27 27 27])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
310
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
311 ;; * GETTING MORE HELP
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
312 ;; The most basic HELP feature is C-h c
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
313 (describe-key-briefly [?\C-h ?c])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
314 (describe-key [?\C-h ?k])
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
315
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
316 ;; * MORE FEATURES
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
317 ;; F10
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
318
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
319 ;; * CONCLUSION
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
320 ;;(iconify-or-deiconify-frame [?\C-z])
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
321 (,suspend-emacs [?\C-z]))))
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
322 (sort default-keys 'tutorial--sort-keys))
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
323 "Default Emacs key bindings that the tutorial depends on.")
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
324
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
325 (defun tutorial--detailed-help (button)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
326 "Give detailed help about changed keys."
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
327 (with-output-to-temp-buffer (help-buffer)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
328 (help-setup-xref (list #'tutorial--detailed-help button)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
329 (interactive-p))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
330 (with-current-buffer (help-buffer)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
331 (let* ((tutorial-buffer (button-get button 'tutorial-buffer))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
332 (explain-key-desc (button-get button 'explain-key-desc))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
333 (changed-keys (with-current-buffer tutorial-buffer
74113
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
334 (save-excursion
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
335 (goto-char (point-min))
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
336 (tutorial--find-changed-keys
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
337 tutorial--default-keys)))))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
338 (when changed-keys
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
339 (insert
75557
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
340 "The following key bindings used in the tutorial have been changed
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
341 from the Emacs default:\n\n" )
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
342 (let ((frm " %-14s %-27s %-16s\n"))
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
343 (insert (format frm
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
344 "Standard Key" "Command" "In Your Emacs")))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
345 (dolist (tk changed-keys)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
346 (let* ((def-fun (nth 1 tk))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
347 (key (nth 0 tk))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
348 (def-fun-txt (nth 2 tk))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
349 (where (nth 3 tk))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
350 (remark (nth 4 tk))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
351 (rem-fun (command-remapping def-fun))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
352 (key-txt (key-description key))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
353 (key-fun (with-current-buffer tutorial-buffer (key-binding key)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
354 tot-len)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
355 (unless (eq def-fun key-fun)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
356 ;; Insert key binding description:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
357 (when (string= key-txt explain-key-desc)
74100
9b8e3f194cc1 (tutorial-warning-face): New face.
Chong Yidong <cyd@stupidchicken.com>
parents: 73567
diff changeset
358 (put-text-property 0 (length key-txt)
9b8e3f194cc1 (tutorial-warning-face): New face.
Chong Yidong <cyd@stupidchicken.com>
parents: 73567
diff changeset
359 'face 'tutorial-warning-face key-txt))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
360 (insert " " key-txt " ")
75557
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
361 (indent-to 18)
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
362 ;; Insert a link describing the old binding:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
363 (insert-button def-fun-txt
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
364 'value def-fun
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
365 'action
75557
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
366 (lambda (button) (interactive)
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
367 (describe-function
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
368 (button-get button 'value)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
369 'follow-link t)
75557
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
370 (indent-to 45)
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
371 (when (listp where)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
372 (setq where "list"))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
373 ;; Tell where the old binding is now:
75557
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
374 (insert (format " %-16s "
74113
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
375 (if (string= "" where)
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
376 (format "M-x %s" def-fun-txt)
3cc044eb98b7 (tutorial--default-keys): Add newline and delete-backward-char bindings.
Chong Yidong <cyd@stupidchicken.com>
parents: 74100
diff changeset
377 where)))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
378 ;; Insert a link with more information, for example
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
379 ;; current binding and keymap or information about
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
380 ;; cua-mode replacements:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
381 (insert-button (car remark)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
382 'action
75557
21cbf755a07c (tutorial--detailed-help): Make the list of changed keys look nicer.
Richard M. Stallman <rms@gnu.org>
parents: 75471
diff changeset
383 (lambda (b) (interactive)
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
384 (let ((value (button-get b 'value)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
385 (tutorial--describe-nonstandard-key value)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
386 'value (cdr remark)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
387 'follow-link t)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
388 (insert "\n")))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
389
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
390 (insert "
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
391 It is OK to change key bindings, but changed bindings do not
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
392 correspond to what the tutorial says.\n\n")
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
393 (print-help-return-message)))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
394
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
395 (defun tutorial--find-changed-keys (default-keys)
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
396 "Find the key bindings used in the tutorial that have changed.
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
397 Return a list with elements of the form
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
398
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
399 '(KEY DEF-FUN DEF-FUN-TXT WHERE REMARK QUIET)
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
400
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
401 where
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
402
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
403 KEY is a key sequence whose standard binding has been changed
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
404 DEF-FUN is the standard binding of KEY
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
405 DEF-FUN-TXT is a short descriptive text for DEF-FUN
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
406 WHERE is a text describing the key sequences to which DEF-FUN is
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
407 bound now (or, if it is remapped, a key sequence
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
408 for the function it is remapped to)
81215
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
409 REMARK is a list with info about rebinding. It has either of
77717
88eb7407b1e4 (get-lang-string, tutorial--find-changed-keys): Fix typos in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 76210
diff changeset
410 these formats:
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
411
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
412 \(TEXT cua-mode)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
413 \(TEXT current-binding KEY-FUN DEF-FUN KEY WHERE)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
414
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
415 Here TEXT is a link text to show to the user. The
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
416 rest of the list is used to show information when
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
417 the user clicks the link.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
418
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
419 KEY-FUN is the actual binding for KEY.
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
420 QUIET is t if this changed keybinding should be handled quietly.
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
421 This is used by `tutorial--display-changes'."
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
422 (let (changed-keys remark)
75471
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
423 ;; Look up the bindings in a Fundamental mode buffer
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
424 ;; so we do not get fooled by some other major mode.
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
425 (with-temp-buffer
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
426 (fundamental-mode)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
427 (dolist (kdf default-keys)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
428 ;; The variables below corresponds to those with the same names
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
429 ;; described in the doc string.
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
430 (let* ((key (nth 1 kdf))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
431 (def-fun (nth 0 kdf))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
432 (def-fun-txt (format "%s" def-fun))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
433 (rem-fun (command-remapping def-fun))
78136
35849fc29fa6 (tutorial--find-changed-keys): Handle C-x specially like ESC.
Richard M. Stallman <rms@gnu.org>
parents: 77717
diff changeset
434 ;; Handle prefix definitions specially
35849fc29fa6 (tutorial--find-changed-keys): Handle C-x specially like ESC.
Richard M. Stallman <rms@gnu.org>
parents: 77717
diff changeset
435 ;; so that a mode that rebinds some subcommands
35849fc29fa6 (tutorial--find-changed-keys): Handle C-x specially like ESC.
Richard M. Stallman <rms@gnu.org>
parents: 77717
diff changeset
436 ;; won't make it appear that the whole prefix is gone.
75471
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
437 (key-fun (if (eq def-fun 'ESC-prefix)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
438 (lookup-key global-map [27])
78136
35849fc29fa6 (tutorial--find-changed-keys): Handle C-x specially like ESC.
Richard M. Stallman <rms@gnu.org>
parents: 77717
diff changeset
439 (if (eq def-fun 'Control-X-prefix)
35849fc29fa6 (tutorial--find-changed-keys): Handle C-x specially like ESC.
Richard M. Stallman <rms@gnu.org>
parents: 77717
diff changeset
440 (lookup-key global-map [24])
35849fc29fa6 (tutorial--find-changed-keys): Handle C-x specially like ESC.
Richard M. Stallman <rms@gnu.org>
parents: 77717
diff changeset
441 (key-binding key))))
81215
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
442 (where (where-is-internal (if rem-fun rem-fun def-fun)))
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
443 cwhere)
78136
35849fc29fa6 (tutorial--find-changed-keys): Handle C-x specially like ESC.
Richard M. Stallman <rms@gnu.org>
parents: 77717
diff changeset
444
75471
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
445 (if where
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
446 (progn
81215
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
447 (setq cwhere (car where)
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
448 where (key-description cwhere))
75471
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
449 (when (and (< 10 (length where))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
450 (string= (substring where 0 (length "<menu-bar>"))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
451 "<menu-bar>"))
81215
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
452 (setq where
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
453 (if (and (vectorp cwhere)
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
454 (setq cwhere (elt cwhere 1))
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
455 (setq cwhere
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
456 (cadr
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
457 (assoc cwhere
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
458 (lookup-key global-map
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
459 [menu-bar]))))
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
460 (stringp cwhere))
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
461 (format "the `%s' menu" cwhere)
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
462 "the menus"))))
75471
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
463 (setq where ""))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
464 (setq remark nil)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
465 (unless
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
466 (cond ((eq key-fun def-fun)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
467 ;; No rebinding, return t
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
468 t)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
469 ((and key-fun
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
470 (eq key-fun (command-remapping def-fun)))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
471 ;; Just a remapping, return t
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
472 t)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
473 ;; cua-mode specials:
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
474 ((and cua-mode
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
475 (or (and
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
476 (equal key [?\C-v])
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
477 (eq key-fun 'cua-paste))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
478 (and
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
479 (equal key [?\C-z])
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
480 (eq key-fun 'undo))))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
481 (setq remark (list "cua-mode, more info" 'cua-mode))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
482 nil)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
483 ((and cua-mode
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
484 (or (and (eq def-fun 'ESC-prefix)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
485 (equal key-fun
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
486 `(keymap
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
487 (118 . cua-repeat-replace-region)))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
488 (setq def-fun-txt "\"ESC prefix\""))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
489 (and (eq def-fun 'mode-specific-command-prefix)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
490 (equal key-fun
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
491 '(keymap
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
492 (timeout . copy-region-as-kill)))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
493 (setq def-fun-txt "\"C-c prefix\""))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
494 (and (eq def-fun 'Control-X-prefix)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
495 (equal key-fun
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
496 '(keymap (timeout . kill-region)))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
497 (setq def-fun-txt "\"C-x prefix\""))))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
498 (setq remark (list "cua-mode replacement" 'cua-mode))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
499 (setq where "Same key")
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
500 nil)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
501 ;; viper-mode specials:
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
502 ((and (boundp 'viper-mode-string)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
503 (boundp 'viper-current-state)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
504 (eq viper-current-state 'vi-state)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
505 (or (and (eq def-fun 'isearch-forward)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
506 (eq key-fun 'viper-isearch-forward))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
507 (and (eq def-fun 'isearch-backward)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
508 (eq key-fun 'viper-isearch-backward))))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
509 ;; These bindings works as the default bindings,
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
510 ;; return t
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
511 t)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
512 ((when normal-erase-is-backspace
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
513 (or (and (equal key [C-delete])
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
514 (equal key-fun 'kill-word))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
515 (and (equal key [C-backspace])
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
516 (equal key-fun 'backward-kill-word))))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
517 ;; This is the strange handling of C-delete and
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
518 ;; C-backspace, return t
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
519 t)
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
520 (t
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
521 ;; This key has indeed been rebound. Put information
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
522 ;; in `remark' and return nil
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
523 (setq remark
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
524 (list "more info" 'current-binding
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
525 key-fun def-fun key where))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
526 nil))
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
527 (add-to-list 'changed-keys
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
528 (list key def-fun def-fun-txt where remark nil))))))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
529 changed-keys))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
530
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
531 (defun tutorial--key-description (key)
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
532 (let ((desc (key-description key)))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
533 (cond ((string= "ESC" desc) "<ESC>")
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
534 ((string= "RET" desc) "<Return>")
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
535 ((string= "DEL" desc) "<Delback>")
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
536 (t desc))))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
537
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
538 (defun tutorial--display-changes ()
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
539 "Display changes to some default key bindings.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
540 If some of the default key bindings that the tutorial depends on
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
541 have been changed then display the changes in the tutorial buffer
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
542 with some explanatory links."
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
543 (let* ((changed-keys (tutorial--find-changed-keys
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
544 tutorial--default-keys))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
545 ;; Alist of element (DESC . CK) where DESC is the
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
546 ;; key-description of a changed key and CK is the
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
547 ;; corresponding element in `changed-keys'.
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
548 (changed-keys-alist
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
549 (mapcar (lambda (ck) (cons (tutorial--key-description (car ck)) ck))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
550 changed-keys))
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
551 changed-key
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
552 (start (point))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
553 (case-fold-search nil)
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
554 (keybindings-regexp
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
555 (concat "[[:space:]]\\("
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
556 (mapconcat (lambda (kdf) (regexp-quote
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
557 (tutorial--key-description
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
558 (nth 1 kdf))))
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
559 tutorial--default-keys
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
560 "\\|")
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
561 "\\)[[:punct:][:space:]]")))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
562 ;; Need the custom button face for viper buttons:
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
563 (if (boundp 'viper-mode-string) (require 'cus-edit))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
564
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
565 (if (or changed-keys (boundp 'viper-mode-string))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
566 (let ((head (get-lang-string tutorial--lang 'tut-chgdhead))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
567 (head2 (get-lang-string tutorial--lang 'tut-chgdhead2)))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
568 (when (and head head2)
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
569 (goto-char tutorial--point-before-chkeys)
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
570 (insert head " [")
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
571 (insert-button head2 'tutorial-buffer (current-buffer)
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
572 'action 'tutorial--detailed-help
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
573 'follow-link t 'face 'link)
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
574 (insert "]\n\n")
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
575 (add-text-properties tutorial--point-before-chkeys (point)
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
576 '(tutorial-remark remark
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
577 face tutorial-warning-face
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
578 read-only t)))))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
579
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
580 ;; Scan the tutorial for all key sequences.
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
581 (goto-char (point-min))
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
582 (while (re-search-forward keybindings-regexp (point-max) t)
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
583 ;; Then highlight each rebound key sequence.
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
584 ;; This avoids issuing a warning for, e.g., C-x C-b if C-b is rebound.
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
585 (setq changed-key (assoc (match-string 1) changed-keys-alist))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
586 (and changed-key
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
587 (not (get-text-property (match-beginning 1) 'tutorial-remark))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
588 (let* ((desc (car changed-key))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
589 (ck (cdr changed-key))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
590 (key (nth 0 ck))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
591 (def-fun (nth 1 ck))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
592 (where (nth 3 ck))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
593 s1 s2 help-string)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
594 (unless (string= where "Same key")
75162
4ad75aa56c40 (tutorial--display-changes): Show M-x sequence if no
Chong Yidong <cyd@stupidchicken.com>
parents: 75069
diff changeset
595 (when (string= where "")
4ad75aa56c40 (tutorial--display-changes): Show M-x sequence if no
Chong Yidong <cyd@stupidchicken.com>
parents: 75069
diff changeset
596 (setq where (format "M-x %s" def-fun)))
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
597 (setq tutorial--point-after-chkeys (point-marker)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
598 s1 (get-lang-string tutorial--lang 'tut-chgdkey)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
599 s2 (get-lang-string tutorial--lang 'tut-chgdkey2)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
600 help-string (and s1 s2 (format s1 desc where)))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
601 (add-text-properties (match-beginning 1) (match-end 1)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
602 '(face tutorial-warning-face
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
603 tutorial-remark key-sequence))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
604 (if help-string
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
605 (if (nth 5 ck)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
606 ;; Put help string in the tooltip.
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
607 (put-text-property (match-beginning 1) (match-end 1)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
608 'help-echo help-string)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
609 ;; Put help string in the buffer.
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
610 (save-excursion
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
611 (setcar (nthcdr 5 ck) t)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
612 (forward-line)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
613 ;; Two or more changed keys were on the same line.
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
614 (while (eq (get-text-property (point) 'tutorial-remark)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
615 'remark)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
616 (forward-line))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
617 (setq start (point))
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
618 (insert "** " help-string " [")
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
619 (insert-button s2 'tutorial-buffer (current-buffer)
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
620 'action 'tutorial--detailed-help
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
621 'explain-key-desc desc 'follow-link t
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
622 'face 'link)
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
623 (insert "] **\n")
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
624 (add-text-properties start (point)
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
625 '(tutorial-remark remark
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
626 rear-nonsticky t
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
627 face tutorial-warning-face
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
628 read-only t)))))))))))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
629
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
630 (defun tutorial--saved-dir ()
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
631 "Directory to which tutorials are saved."
81350
e345103787bc (tutorial--saved-dir): Use user-emacs-directory.
Chong Yidong <cyd@stupidchicken.com>
parents: 81215
diff changeset
632 (expand-file-name "tutorial" user-emacs-directory))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
633
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
634 (defun tutorial--saved-file ()
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
635 "File name in which to save tutorials."
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
636 (let ((file-name tutorial--lang)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
637 (ext (file-name-extension tutorial--lang)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
638 (when (or (not ext)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
639 (string= ext ""))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
640 (setq file-name (concat file-name ".tut")))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
641 (expand-file-name file-name (tutorial--saved-dir))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
642
75471
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
643 (defun tutorial--remove-remarks ()
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
644 "Remove the remark lines that was added to the tutorial buffer."
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
645 (save-excursion
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
646 (goto-char (point-min))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
647 (let (prop-start
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
648 prop-end
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
649 prop-val)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
650 ;; Catch the case when we already are on a remark line
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
651 (while (if (get-text-property (point) 'tutorial-remark)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
652 (setq prop-start (point))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
653 (setq prop-start (next-single-property-change (point) 'tutorial-remark)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
654 (setq prop-end (next-single-property-change prop-start 'tutorial-remark))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
655 (setq prop-val (get-text-property prop-start 'tutorial-remark))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
656 (unless prop-end
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
657 (setq prop-end (point-max)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
658 (goto-char prop-end)
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
659 (unless (eq prop-val 'key-sequence)
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
660 (delete-region prop-start prop-end))))))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
661
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
662 (defun tutorial--save-tutorial ()
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
663 "Save the tutorial buffer.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
664 This saves the part of the tutorial before and after the area
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
665 showing changed keys. It also saves the point position and the
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
666 position where the display of changed bindings was inserted."
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
667 ;; This runs in a hook so protect it:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
668 (condition-case err
74797
90a64762539d (tutorial--save-tutorial): Prompt before saving tutorial state.
Chong Yidong <cyd@stupidchicken.com>
parents: 74795
diff changeset
669 (if (y-or-n-p "Save your position in the tutorial? ")
90a64762539d (tutorial--save-tutorial): Prompt before saving tutorial state.
Chong Yidong <cyd@stupidchicken.com>
parents: 74795
diff changeset
670 (tutorial--save-tutorial-to (tutorial--saved-file)))
90a64762539d (tutorial--save-tutorial): Prompt before saving tutorial state.
Chong Yidong <cyd@stupidchicken.com>
parents: 74795
diff changeset
671 (error (message "Error saving tutorial state: %s"
90a64762539d (tutorial--save-tutorial): Prompt before saving tutorial state.
Chong Yidong <cyd@stupidchicken.com>
parents: 74795
diff changeset
672 (error-message-string err)))))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
673
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
674 (defun tutorial--save-tutorial-to (saved-file)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
675 "Save the tutorial buffer to SAVED-FILE.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
676 See `tutorial--save-tutorial' for more information."
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
677 ;; Anything to save?
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
678 (when (or (buffer-modified-p)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
679 (< 1 (point)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
680 (let ((tutorial-dir (tutorial--saved-dir))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
681 save-err)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
682 ;; The tutorial is saved in a subdirectory in the user home
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
683 ;; directory. Create this subdirectory first.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
684 (unless (file-directory-p tutorial-dir)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
685 (condition-case err
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
686 (make-directory tutorial-dir nil)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
687 (error (setq save-err t)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
688 (warn "Could not create directory %s: %s" tutorial-dir
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
689 (error-message-string err)))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
690 ;; Make sure we have that directory.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
691 (if (file-directory-p tutorial-dir)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
692 (let ((tut-point (if (= 0 tutorial--point-after-chkeys)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
693 ;; No info about changed keys is
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
694 ;; displayed.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
695 (point)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
696 (if (< (point) tutorial--point-after-chkeys)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
697 (- (point))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
698 (- (point) tutorial--point-after-chkeys))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
699 (old-point (point))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
700 ;; Use a special undo list so that we easily can undo
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
701 ;; the changes we make to the tutorial buffer. This is
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
702 ;; currently not needed since we now delete the buffer
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
703 ;; after saving, but kept for possible future use of
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
704 ;; this function.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
705 buffer-undo-list
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
706 (inhibit-read-only t))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
707 ;; Delete the area displaying info about changed keys.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
708 ;; (when (< 0 tutorial--point-after-chkeys)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
709 ;; (delete-region tutorial--point-before-chkeys
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
710 ;; tutorial--point-after-chkeys))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
711 ;; Delete the remarks:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
712 (tutorial--remove-remarks)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
713 ;; Put the value of point first in the buffer so it will
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
714 ;; be saved with the tutorial.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
715 (goto-char (point-min))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
716 (insert (number-to-string tut-point)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
717 "\n"
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
718 (number-to-string (marker-position
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
719 tutorial--point-before-chkeys))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
720 "\n")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
721 (condition-case err
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
722 (write-region nil nil saved-file)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
723 (error (setq save-err t)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
724 (warn "Could not save tutorial to %s: %s"
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
725 saved-file
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
726 (error-message-string err))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
727 ;; An error is raised here?? Is this a bug?
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
728 (condition-case err
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
729 (undo-only)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
730 (error nil))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
731 ;; Restore point
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
732 (goto-char old-point)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
733 (if save-err
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
734 (message "Could not save tutorial state.")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
735 (message "Saved tutorial state.")))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
736 (message "Can't save tutorial: %s is not a directory"
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
737 tutorial-dir)))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
738
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
739
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
740 ;;;###autoload
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
741 (defun help-with-tutorial (&optional arg dont-ask-for-revert)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
742 "Select the Emacs learn-by-doing tutorial.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
743 If there is a tutorial version written in the language
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
744 of the selected language environment, that version is used.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
745 If there's no tutorial in that language, `TUTORIAL' is selected.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
746 With ARG, you are asked to choose which language.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
747 If DONT-ASK-FOR-REVERT is non-nil the buffer is reverted without
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
748 any question when restarting the tutorial.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
749
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
750 If any of the standard Emacs key bindings that are used in the
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
751 tutorial have been changed then an explanatory note about this is
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
752 shown in the beginning of the tutorial buffer.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
753
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
754 When the tutorial buffer is killed the content and the point
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
755 position in the buffer is saved so that the tutorial may be
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
756 resumed later."
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
757 (interactive "P")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
758 (if (boundp 'viper-current-state)
73551
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
759 (let ((prompt1
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
760 "You can not run the Emacs tutorial directly because you have \
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
761 enabled Viper.")
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
762 (prompt2 "\nThere is however a Viper tutorial you can run instead.
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
763 Run the Viper tutorial? "))
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
764 (if (fboundp 'viper-tutorial)
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
765 (if (y-or-n-p (concat prompt1 prompt2))
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
766 (progn (message "")
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
767 (funcall 'viper-tutorial 0))
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
768 (message "Tutorial aborted by user"))
8bd77d06776b * tutorial.el: Move defvars to avoid bytecomp warnings.
Chong Yidong <cyd@stupidchicken.com>
parents: 73550
diff changeset
769 (message prompt1)))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
770 (let* ((lang (if arg
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
771 (let ((minibuffer-setup-hook minibuffer-setup-hook))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
772 (add-hook 'minibuffer-setup-hook
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
773 'minibuffer-completion-help)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
774 (read-language-name 'tutorial "Language: " "English"))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
775 (if (get-language-info current-language-environment 'tutorial)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
776 current-language-environment
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
777 "English")))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
778 (filename (get-language-info lang 'tutorial))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
779 ;; Choose a buffer name including the language so that
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
780 ;; several languages can be tested simultaneously:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
781 (tut-buf-name (concat "TUTORIAL (" lang ")"))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
782 (old-tut-buf (get-buffer tut-buf-name))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
783 (old-tut-win (when old-tut-buf (get-buffer-window old-tut-buf t)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
784 (old-tut-is-ok (when old-tut-buf
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
785 (not (buffer-modified-p old-tut-buf))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
786 old-tut-file
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
787 (old-tut-point 1))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
788 (setq tutorial--point-after-chkeys (point-min))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
789 ;; Try to display the tutorial buffer before asking to revert it.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
790 ;; If the tutorial buffer is shown in some window make sure it is
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
791 ;; selected and displayed:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
792 (if old-tut-win
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
793 (raise-frame
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
794 (window-frame
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
795 (select-window (get-buffer-window old-tut-buf t))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
796 ;; Else, is there an old tutorial buffer? Then display it:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
797 (when old-tut-buf
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
798 (switch-to-buffer old-tut-buf)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
799 ;; Use whole frame for tutorial
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
800 (delete-other-windows)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
801 ;; If the tutorial buffer has been changed then ask if it should
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
802 ;; be reverted:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
803 (when (and old-tut-buf
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
804 (not old-tut-is-ok))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
805 (setq old-tut-is-ok
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
806 (if dont-ask-for-revert
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
807 nil
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
808 (not (y-or-n-p
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
809 "You have changed the Tutorial buffer. Revert it? ")))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
810 ;; (Re)build the tutorial buffer if it is not ok
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
811 (unless old-tut-is-ok
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
812 (switch-to-buffer (get-buffer-create tut-buf-name))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
813 (unless old-tut-buf (text-mode))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
814 (unless lang (error "Variable lang is nil"))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
815 (setq tutorial--lang lang)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
816 (setq old-tut-file (file-exists-p (tutorial--saved-file)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
817 (let ((inhibit-read-only t))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
818 (erase-buffer))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
819 (message "Preparing tutorial ...") (sit-for 0)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
820
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
821 ;; Do not associate the tutorial buffer with a file. Instead use
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
822 ;; a hook to save it when the buffer is killed.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
823 (setq buffer-auto-save-file-name nil)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
824 (add-hook 'kill-buffer-hook 'tutorial--save-tutorial nil t)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
825
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
826 ;; Insert the tutorial. First offer to resume last tutorial
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
827 ;; editing session.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
828 (when dont-ask-for-revert
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
829 (setq old-tut-file nil))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
830 (when old-tut-file
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
831 (setq old-tut-file
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
832 (y-or-n-p "Resume your last saved tutorial? ")))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
833 (if old-tut-file
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
834 (progn
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
835 (insert-file-contents (tutorial--saved-file))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
836 (goto-char (point-min))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
837 (setq old-tut-point
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
838 (string-to-number
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
839 (buffer-substring-no-properties
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
840 (line-beginning-position) (line-end-position))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
841 (forward-line)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
842 (setq tutorial--point-before-chkeys
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
843 (string-to-number
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
844 (buffer-substring-no-properties
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
845 (line-beginning-position) (line-end-position))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
846 (forward-line)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
847 (delete-region (point-min) (point))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
848 (goto-char tutorial--point-before-chkeys)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
849 (setq tutorial--point-before-chkeys (point-marker)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
850 (insert-file-contents (expand-file-name filename data-directory))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
851 (forward-line)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
852 (setq tutorial--point-before-chkeys (point-marker)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
853
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
854 (tutorial--display-changes)
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
855
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
856 ;; Clear message:
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
857 (unless dont-ask-for-revert
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
858 (message "") (sit-for 0))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
859
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
860
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
861 (if old-tut-file
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
862 ;; Just move to old point in saved tutorial.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
863 (let ((old-point
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
864 (if (> 0 old-tut-point)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
865 (- old-tut-point)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
866 (+ old-tut-point tutorial--point-after-chkeys))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
867 (when (< old-point 1)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
868 (setq old-point 1))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
869 (goto-char old-point))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
870 (goto-char (point-min))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
871 (search-forward "\n<<")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
872 (beginning-of-line)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
873 ;; Convert the <<...>> line to the proper [...] line,
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
874 ;; or just delete the <<...>> line if a [...] line follows.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
875 (cond ((save-excursion
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
876 (forward-line 1)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
877 (looking-at "\\["))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
878 (delete-region (point) (progn (forward-line 1) (point))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
879 ((looking-at "<<Blank lines inserted.*>>")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
880 (replace-match "[Middle of page left blank for didactic purposes. Text continues below]"))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
881 (t
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
882 (looking-at "<<")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
883 (replace-match "[")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
884 (search-forward ">>")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
885 (replace-match "]")))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
886 (beginning-of-line)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
887 (let ((n (- (window-height (selected-window))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
888 (count-lines (point-min) (point))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
889 6)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
890 (if (< n 8)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
891 (progn
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
892 ;; For a short gap, we don't need the [...] line,
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
893 ;; so delete it.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
894 (delete-region (point) (progn (end-of-line) (point)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
895 (newline n))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
896 ;; Some people get confused by the large gap.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
897 (newline (/ n 2))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
898
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
899 ;; Skip the [...] line (don't delete it).
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
900 (forward-line 1)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
901 (newline (- n (/ n 2)))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
902 (goto-char (point-min)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
903 (setq buffer-undo-list nil)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
904 (set-buffer-modified-p nil)))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
905
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
906
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
907 ;; Below is some attempt to handle language specific strings. These
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
908 ;; are currently only used in the tutorial.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
909
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
910 (defconst lang-strings
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
911 '(("English" .
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
912 ((tut-chgdkey . "%s has been rebound, but you can use %s instead")
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
913 (tut-chgdkey2 . "More")
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
914 (tut-chgdhead . "
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
915 NOTICE: The main purpose of the Emacs tutorial is to teach you
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
916 the most important standard Emacs commands (key bindings).
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
917 However, your Emacs has been customized by changing some of
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
918 these basic editing commands, so it doesn't correspond to the
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
919 tutorial. We have inserted colored notices where the altered
74795
4404b91f3a72 (tutorial--detailed-help): Remove unnecessary link
Chong Yidong <cyd@stupidchicken.com>
parents: 74789
diff changeset
920 commands have been introduced.")
74789
ecc3f98301f4 Remove `cl' requirement. Clean up whitespace.
Chong Yidong <cyd@stupidchicken.com>
parents: 74113
diff changeset
921 (tut-chgdhead2 . "More"))))
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
922 "Language specific strings for Emacs.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
923 This is an association list with the keys equal to the strings
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
924 that can be returned by `read-language-name'. The elements in
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
925 the list are themselves association lists with keys that are
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
926 string ids and values that are the language specific strings.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
927
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
928 See `get-lang-string' for more information.")
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
929
75471
afea84ac9ef8 (tutorial--default-keys): Check M-DEL, not `M-backspace'.
Richard M. Stallman <rms@gnu.org>
parents: 75347
diff changeset
930 (defun get-lang-string (lang stringid &optional no-eng-fallback)
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
931 "Get a language specific string for Emacs.
77717
88eb7407b1e4 (get-lang-string, tutorial--find-changed-keys): Fix typos in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 76210
diff changeset
932 In certain places Emacs can replace a string shown to the user with
88eb7407b1e4 (get-lang-string, tutorial--find-changed-keys): Fix typos in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 76210
diff changeset
933 a language specific string. This function retrieves such strings.
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
934
81215
569dae55f278 (tutorial--describe-nonstandard-key): Adjust for new
Glenn Morris <rgm@gnu.org>
parents: 77717
diff changeset
935 LANG is the language specification. It should be one of those
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
936 strings that can be returned by `read-language-name'. STRINGID
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
937 is a symbol that specifies the string to retrieve.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
938
77717
88eb7407b1e4 (get-lang-string, tutorial--find-changed-keys): Fix typos in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 76210
diff changeset
939 If no string is found for STRINGID in the chosen language then
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
940 the English string is returned unless NO-ENG-FALLBACK is non-nil.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
941
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
942 See `lang-strings' for more information.
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
943
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
944 Currently this feature is only used in `help-with-tutorial'."
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
945 (let ((my-lang-strings (assoc lang lang-strings))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
946 (found-string))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
947 (when my-lang-strings
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
948 (let ((entry (assoc stringid (cdr my-lang-strings))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
949 (when entry
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
950 (setq found-string (cdr entry)))))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
951 ;; Fallback to English strings
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
952 (unless (or found-string
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
953 no-eng-fallback)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
954 (setq found-string (get-lang-string "English" stringid t)))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
955 found-string))
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
956
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
957 ;;(get-lang-string "English" 'tut-chgdkey)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
958
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
959 (provide 'tutorial)
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
960
73567
14e412e445c1 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 73552
diff changeset
961 ;; arch-tag: c8e80aef-c3bb-4ffb-8af6-22171bf0c100
73550
6deaec97f21b * help-fns.el (help-with-tutorial): Moved to tutorial.el.
Chong Yidong <cyd@stupidchicken.com>
parents:
diff changeset
962 ;;; tutorial.el ends here