diff options
| author | Juanma Barranquero | 2005-07-20 23:09:56 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2005-07-20 23:09:56 +0000 |
| commit | 69c3280d4db2833d27cbc46a4480b5047749d072 (patch) | |
| tree | 0eaf33643455e41f5e66145252df83f499b93d3d | |
| parent | afdff50e24fc50d7c16ea3a2c1ba922272b69fa0 (diff) | |
| download | emacs-69c3280d4db2833d27cbc46a4480b5047749d072.tar.gz emacs-69c3280d4db2833d27cbc46a4480b5047749d072.zip | |
(strokes-load-hook): Doc fix.
(strokes-grid-resolution, strokes-get-grid-position,
strokes-renormalize-to-grid, strokes-read-stroke, strokes-read-complex-stroke,
strokes-file, strokes-last-stroke, strokes-global-map): Fix typos in docstrings.
(strokes-help): Doc fix. Fix help message and pass it through
`substitute-command-keys'.
| -rw-r--r-- | lisp/ChangeLog | 23 | ||||
| -rw-r--r-- | lisp/strokes.el | 31 |
2 files changed, 39 insertions, 15 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index e4840d08283..42dd8820aa1 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,3 +1,26 @@ | |||
| 1 | 2005-07-21 Juanma Barranquero <lekktu@gmail.com> | ||
| 2 | |||
| 3 | * simple.el (clone-indirect-buffer): Doc fix. | ||
| 4 | (fixup-whitespace, just-one-space) | ||
| 5 | (backward-delete-char-untabify, lambda): "?\ " -> "?\s". | ||
| 6 | (next-error, next-error-highlight) | ||
| 7 | (next-error-highlight-no-select, next-error-last-buffer) | ||
| 8 | (next-error-buffer-p, next-error-find-buffer, next-error) | ||
| 9 | (previous-error, next-error-no-select, previous-error-no-select) | ||
| 10 | (open-line, split-line, minibuffer-prompt-width, kill-new) | ||
| 11 | (binary-overwrite-mode): Fix typos in docstrings. | ||
| 12 | (set-fill-column): Fix typo in message. | ||
| 13 | |||
| 14 | * skeleton.el (skeleton-proxy-new): Doc fix. | ||
| 15 | |||
| 16 | * strokes.el (strokes-load-hook): Doc fix. | ||
| 17 | (strokes-grid-resolution, strokes-get-grid-position) | ||
| 18 | (strokes-renormalize-to-grid, strokes-read-stroke) | ||
| 19 | (strokes-read-complex-stroke, strokes-file, strokes-last-stroke) | ||
| 20 | (strokes-global-map): Fix typos in docstrings. | ||
| 21 | (strokes-help): Doc fix. Fix help message and pass it through | ||
| 22 | `substitute-command-keys'. | ||
| 23 | |||
| 1 | 2005-07-20 Kim F. Storm <storm@cua.dk> | 24 | 2005-07-20 Kim F. Storm <storm@cua.dk> |
| 2 | 25 | ||
| 3 | * emulation/cua-base.el (cua-mode): Improve doc string. | 26 | * emulation/cua-base.el (cua-mode): Improve doc string. |
diff --git a/lisp/strokes.el b/lisp/strokes.el index bb99591d1e1..a35a5d6f161 100644 --- a/lisp/strokes.el +++ b/lisp/strokes.el | |||
| @@ -243,9 +243,9 @@ ones, then strokes should NOT pick the one that came closest." | |||
| 243 | 243 | ||
| 244 | (defcustom strokes-grid-resolution 9 | 244 | (defcustom strokes-grid-resolution 9 |
| 245 | "*Integer defining dimensions of the stroke grid. | 245 | "*Integer defining dimensions of the stroke grid. |
| 246 | The grid is a square grid, where STROKES-GRID-RESOLUTION defaults to | 246 | The grid is a square grid, where `strokes-grid-resolution' defaults to |
| 247 | `9', making a 9x9 grid whose coordinates go from (0 . 0) on the top | 247 | `9', making a 9x9 grid whose coordinates go from (0 . 0) on the top |
| 248 | left to ((STROKES-GRID-RESOLUTION - 1) . (STROKES-GRID-RESOLUTION - 1)) | 248 | left to ((strokes-grid-resolution - 1) . (strokes-grid-resolution - 1)) |
| 249 | on the bottom right. The greater the resolution, the more intricate | 249 | on the bottom right. The greater the resolution, the more intricate |
| 250 | your strokes can be. | 250 | your strokes can be. |
| 251 | NOTE: This variable should be odd and MUST NOT be less than 3 and need | 251 | NOTE: This variable should be odd and MUST NOT be less than 3 and need |
| @@ -259,7 +259,7 @@ WARNING: Changing the value of this variable will gravely affect the | |||
| 259 | :group 'strokes) | 259 | :group 'strokes) |
| 260 | 260 | ||
| 261 | (defcustom strokes-file (convert-standard-filename "~/.strokes") | 261 | (defcustom strokes-file (convert-standard-filename "~/.strokes") |
| 262 | "*File containing saved strokes for stroke-mode (default is ~/.strokes)." | 262 | "*File containing saved strokes for Strokes mode (default is ~/.strokes)." |
| 263 | :type 'file | 263 | :type 'file |
| 264 | :group 'strokes) | 264 | :group 'strokes) |
| 265 | 265 | ||
| @@ -284,17 +284,17 @@ This is set properly in the function `strokes-update-window-configuration'.") | |||
| 284 | "Last stroke entered by the user. | 284 | "Last stroke entered by the user. |
| 285 | Its value gets set every time the function | 285 | Its value gets set every time the function |
| 286 | `strokes-fill-stroke' gets called, | 286 | `strokes-fill-stroke' gets called, |
| 287 | since that is the best time to set the variable") | 287 | since that is the best time to set the variable.") |
| 288 | 288 | ||
| 289 | (defvar strokes-global-map '() | 289 | (defvar strokes-global-map '() |
| 290 | "Association list of strokes and their definitions. | 290 | "Association list of strokes and their definitions. |
| 291 | Each entry is (STROKE . COMMAND) where STROKE is itself a list of | 291 | Each entry is (STROKE . COMMAND) where STROKE is itself a list of |
| 292 | coordinates (X . Y) where X and Y are lists of positions on the | 292 | coordinates (X . Y) where X and Y are lists of positions on the |
| 293 | normalized stroke grid, with the top left at (0 . 0). COMMAND is the | 293 | normalized stroke grid, with the top left at (0 . 0). COMMAND is the |
| 294 | corresponding interactive function") | 294 | corresponding interactive function.") |
| 295 | 295 | ||
| 296 | (defvar strokes-load-hook nil | 296 | (defvar strokes-load-hook nil |
| 297 | "Function or functions to be called when `strokes' is loaded.") | 297 | "Functions to be called when Strokes is loaded.") |
| 298 | 298 | ||
| 299 | ;;; ### NOT IMPLEMENTED YET ### | 299 | ;;; ### NOT IMPLEMENTED YET ### |
| 300 | ;;(defvar edit-strokes-menu | 300 | ;;(defvar edit-strokes-menu |
| @@ -473,10 +473,10 @@ Compare `strokes-global-set-stroke'." | |||
| 473 | 473 | ||
| 474 | (defun strokes-get-grid-position (stroke-extent position &optional grid-resolution) | 474 | (defun strokes-get-grid-position (stroke-extent position &optional grid-resolution) |
| 475 | "Map POSITION to a new grid position. | 475 | "Map POSITION to a new grid position. |
| 476 | Do so based on its STROKE-EXTENT and GRID-RESOLUTION. | 476 | Do so based on its STROKE-EXTENT and GRID-RESOLUTION. |
| 477 | STROKE-EXTENT as a list \(\(XMIN . YMIN\) \(XMAX . YMAX\)\). | 477 | STROKE-EXTENT as a list \(\(XMIN . YMIN\) \(XMAX . YMAX\)\). |
| 478 | If POSITION is a `strokes-lift', then it is itself returned. | 478 | If POSITION is a `strokes-lift', then it is itself returned. |
| 479 | Optional GRID-RESOLUTION may be used in place of STROKES-GRID-RESOLUTION. | 479 | Optional GRID-RESOLUTION may be used in place of `strokes-grid-resolution'. |
| 480 | The grid is a square whose dimension is [0,GRID-RESOLUTION)." | 480 | The grid is a square whose dimension is [0,GRID-RESOLUTION)." |
| 481 | (cond ((consp position) ; actual pixel location | 481 | (cond ((consp position) ; actual pixel location |
| 482 | (let ((grid-resolution (or grid-resolution strokes-grid-resolution)) | 482 | (let ((grid-resolution (or grid-resolution strokes-grid-resolution)) |
| @@ -566,7 +566,7 @@ The return value is a list ((XMIN . YMIN) (XMAX . YMAX))." | |||
| 566 | (defun strokes-renormalize-to-grid (positions &optional grid-resolution) | 566 | (defun strokes-renormalize-to-grid (positions &optional grid-resolution) |
| 567 | "Map POSITIONS to a new grid whose dimensions are based on GRID-RESOLUTION. | 567 | "Map POSITIONS to a new grid whose dimensions are based on GRID-RESOLUTION. |
| 568 | POSITIONS is a list of positions and stroke-lifts. | 568 | POSITIONS is a list of positions and stroke-lifts. |
| 569 | Optional GRID-RESOLUTION may be used in place of STROKES-GRID-RESOLUTION. | 569 | Optional GRID-RESOLUTION may be used in place of `strokes-grid-resolution'. |
| 570 | The grid is a square whose dimension is [0,GRID-RESOLUTION)." | 570 | The grid is a square whose dimension is [0,GRID-RESOLUTION)." |
| 571 | (or grid-resolution (setq grid-resolution strokes-grid-resolution)) | 571 | (or grid-resolution (setq grid-resolution strokes-grid-resolution)) |
| 572 | (let ((stroke-extent (strokes-get-stroke-extent positions))) | 572 | (let ((stroke-extent (strokes-get-stroke-extent positions))) |
| @@ -726,7 +726,7 @@ Optional PROMPT in minibuffer displays before and during stroke reading. | |||
| 726 | This function will display the stroke interactively as it is being | 726 | This function will display the stroke interactively as it is being |
| 727 | entered in the strokes buffer if the variable | 727 | entered in the strokes buffer if the variable |
| 728 | `strokes-use-strokes-buffer' is non-nil. | 728 | `strokes-use-strokes-buffer' is non-nil. |
| 729 | Optional EVENT is acceptable as the starting event of the stroke" | 729 | Optional EVENT is acceptable as the starting event of the stroke." |
| 730 | (save-excursion | 730 | (save-excursion |
| 731 | (let ((pix-locs nil) | 731 | (let ((pix-locs nil) |
| 732 | (grid-locs nil) | 732 | (grid-locs nil) |
| @@ -790,7 +790,7 @@ Optional PROMPT in minibuffer displays before and during stroke reading. | |||
| 790 | Note that a complex stroke allows the user to pen-up and pen-down. This | 790 | Note that a complex stroke allows the user to pen-up and pen-down. This |
| 791 | is implemented by allowing the user to paint with button 1 or button 2 and | 791 | is implemented by allowing the user to paint with button 1 or button 2 and |
| 792 | then complete the stroke with button 3. | 792 | then complete the stroke with button 3. |
| 793 | Optional EVENT is acceptable as the starting event of the stroke" | 793 | Optional EVENT is acceptable as the starting event of the stroke." |
| 794 | (save-excursion | 794 | (save-excursion |
| 795 | (save-window-excursion | 795 | (save-window-excursion |
| 796 | (set-window-configuration strokes-window-configuration) | 796 | (set-window-configuration strokes-window-configuration) |
| @@ -892,11 +892,12 @@ This must be bound to a mouse event." | |||
| 892 | 892 | ||
| 893 | ;;;###autoload | 893 | ;;;###autoload |
| 894 | (defun strokes-help () | 894 | (defun strokes-help () |
| 895 | "Get instruction on using the `strokes' package." | 895 | "Get instruction on using the Strokes package." |
| 896 | (interactive) | 896 | (interactive) |
| 897 | (with-output-to-temp-buffer "*Help with Strokes*" | 897 | (with-output-to-temp-buffer "*Help with Strokes*" |
| 898 | (princ | 898 | (princ |
| 899 | "This is help for the strokes package. | 899 | (substitute-command-keys |
| 900 | "This is help for the strokes package. | ||
| 900 | 901 | ||
| 901 | ------------------------------------------------------------ | 902 | ------------------------------------------------------------ |
| 902 | 903 | ||
| @@ -986,7 +987,7 @@ You can change this location by setting the variable `strokes-file'. | |||
| 986 | You will be prompted to save them when you exit Emacs, or you can save | 987 | You will be prompted to save them when you exit Emacs, or you can save |
| 987 | them with | 988 | them with |
| 988 | 989 | ||
| 989 | > M-x strokes-save-strokes | 990 | > M-x strokes-prompt-user-save-strokes |
| 990 | 991 | ||
| 991 | Your strokes get loaded automatically when you enable `strokes-mode'. | 992 | Your strokes get loaded automatically when you enable `strokes-mode'. |
| 992 | You can also load in your user-defined strokes with | 993 | You can also load in your user-defined strokes with |
| @@ -1024,7 +1025,7 @@ o Strokes are a bit computer-dependent in that they depend somewhat on | |||
| 1024 | variable which many people wanted to see was | 1025 | variable which many people wanted to see was |
| 1025 | `strokes-use-strokes-buffer' which allows the user to use strokes | 1026 | `strokes-use-strokes-buffer' which allows the user to use strokes |
| 1026 | silently--without displaying the strokes. All variables can be set | 1027 | silently--without displaying the strokes. All variables can be set |
| 1027 | by customizing the group `strokes' via \[customize-group].") | 1028 | by customizing the group `strokes' via \\[customize-group].")) |
| 1028 | (set-buffer standard-output) | 1029 | (set-buffer standard-output) |
| 1029 | (help-mode) | 1030 | (help-mode) |
| 1030 | (print-help-return-message))) | 1031 | (print-help-return-message))) |