From 029a5600b8166d066cfb57687356da750caab562 Mon Sep 17 00:00:00 2001
From: Yuanle Song <sylecn@gmail.com>
Date: Fri, 5 Apr 2019 17:20:10 +0800
Subject: [PATCH] update doc in lisp file header comments

---
 zero-framework.el |  2 --
 zero-pinyin.el    |  4 ++++
 zero-quickdial.el | 26 +++++++++++++++++---------
 zero-table.el     | 14 ++++++++++----
 4 files changed, 31 insertions(+), 15 deletions(-)

diff --git a/zero-framework.el b/zero-framework.el
index f68c315..60cb33c 100644
--- a/zero-framework.el
+++ b/zero-framework.el
@@ -1,8 +1,6 @@
 ;; -*- lexical-binding: t -*-
 ;; the zero Chinese input method framework for emacs.
 ;; implemented as a minor mode.
-;; (load-file "~/lisp/elisp/zero/zero-panel.elc")
-;; (load-file "~/lisp/elisp/zero/zero-framework.elc")
 
 ;;==============
 ;; dependencies
diff --git a/zero-pinyin.el b/zero-pinyin.el
index 889f515..72b128e 100644
--- a/zero-pinyin.el
+++ b/zero-pinyin.el
@@ -1,5 +1,9 @@
 ;; -*- lexical-binding: t -*-
 ;; a pinyin input method for zero-framework
+;; use use this input method, add in emacs init file:
+;; (add-to-list 'load-path "~/lisp/elisp/zero")
+;; (require 'zero-pinyin)
+;; (zero-set-default-im 'pinyin)
 
 ;;==============
 ;; dependencies
diff --git a/zero-quickdial.el b/zero-quickdial.el
index 5e416db..f2a0316 100644
--- a/zero-quickdial.el
+++ b/zero-quickdial.el
@@ -1,5 +1,14 @@
 ;; -*- lexical-binding: t -*-
-;; a simple input method written as an emacs minor mode
+;; zero-quickdial input method written as an emacs minor mode.
+;;
+;; to use this input method,
+;; M-x zero-quickdial-mode    ; turn on IM
+;; type 1 will insert one
+;; type 2 will insert two
+;; type 3 will insert three.
+;; M-x zero-quickdial-mode    ; turn off IM
+;;
+;; This is just a demo of how emacs minor mode can work as input method.
 
 (defun zero-quickdial-insert-one ()
   (interactive)
@@ -13,18 +22,17 @@
   (interactive)
   (insert "three"))
 
-(defvar zero-quickdial-mode-map nil "zero-quickdial-mode keymap")
-
-(setq zero-quickdial-mode-map
-      (list 'keymap
-	    '(49 . zero-quickdial-insert-one)
-	    '(50 . zero-quickdial-insert-two)
-	    '(51 . zero-quickdial-insert-three)))
+(defvar zero-quickdial-mode-map
+  '(keymap
+    (49 . zero-quickdial-insert-one)
+    (50 . zero-quickdial-insert-two)
+    (51 . zero-quickdial-insert-three))
+  "zero-quickdial-mode keymap")
 
 (define-minor-mode zero-quickdial-mode
   "a simple input method written as an emacs minor mode"
   nil
-  "Quickdial"
+  " Quickdial"
   zero-quickdial-mode-map)
 
 (provide 'zero-quickdial)
diff --git a/zero-table.el b/zero-table.el
index c1af9e9..deb648c 100644
--- a/zero-table.el
+++ b/zero-table.el
@@ -1,8 +1,14 @@
 ;; -*- lexical-binding: t -*-
-;; a simple input method written as an emacs minor mode
-;; (load-file "~/lisp/elisp/zero/zero-panel.elc")
-;; (load-file "~/lisp/elisp/zero/zero-framework.elc")
-;; (load-file "~/lisp/elisp/zero/zero-table.elc")
+;; a demo table based input method based on zero-framework.el
+;;
+;; when you type the key in `zero-table-table', IM will insert the
+;; corresponding value.
+;;
+;; To use this demo IM,
+;;   (add-to-list 'load-path "~/lisp/elisp/zero")
+;;   (require 'zero-table)
+;;   (zero-set-default-im 'zero-table) ; set as default IM
+;;   or (zero-set-im 'zero-table)      ; set as current buffer's IM
 
 ;;==============
 ;; dependencies
-- 
GitLab