Commit 00bd5019 authored by Yuanle Song's avatar Yuanle Song
Browse files

prepare to make a release on melpa

- update file list in README
- add "Which panel should I use?" in README
- added a version number in zero-input-panel-posframe.el comments
parent 13e1c607
Loading
Loading
Loading
Loading
+53 −1
Original line number Diff line number Diff line
* COMMENT -*- mode: org -*-
#+Date: 2019-09-01
Time-stamp: <2020-02-23>
Time-stamp: <2024-05-26>

* zero-el

@@ -34,6 +34,50 @@ M-x customize-group zero-input-pinyin
  - There is no ü on US keyboard, type v instead. For example lv 绿.
  - Use ' to separate pinyin substring like xi'an 西安

- Which panel should I use?

  There are three panels for zero-input right now. zero-input panel are based
  on dbus service, so it is easy to implement and easy to plug-and-play.

  zero-panel is a gtk3 app implemented in C to show candidates. It has good
  performance and theme support. You can customize it using gtk ui files and
  css files. You can include images in the panel. But it didn't work in
  wayland at the moment, because positioning window on wayland is non-trivial.

  minibuffer panel, started by (zero-input-panel-minibuffer-init), is a native
  elisp program that use Emacs minibuffer to show candidates. It works
  everywhere Emacs runs, including ttys, X and Wayland.

  posframe panel, started by (zero-input-panel-posframe-init), is a native
  elisp program that uses [[https://github.com/tumashu/posframe][posframe]] to show candidates. It works in X and
  Wayland.

  You can choose whatever works for you. My recommendation would be

  - use zero-panel if mostly running Emacs in X.
  - use posframe panel if you ever run Emacs in Wayland.
  - use minibuffer panel if you are stuck on tty.

  Note that all three can be installed at the same time, but only one may be
  actively running. You can switch panel on the fly while Emacs is running.

  To switch to zero-panel (when zero-panel is installed),
  #+begin_src elisp
    (zero-input-panel-quit)
  #+end_src

  To switch to posframe panel,
  #+begin_src elisp
    (zero-input-panel-quit)
    (zero-input-panel-posframe-init)
  #+end_src

  To switch to minibuffer panel,
  #+begin_src elisp
    (zero-input-panel-quit)
    (zero-input-panel-minibuffer-init)
  #+end_src

* Zero Framework features
- Chinese punctuation mapping. Type the char will insert the corresponding
  Chinese punctuation when zero-input-punctuation-level is basic or full.
@@ -121,6 +165,14 @@ reporting issue easier.
  serves as an example of how to use zero framework to create new input
  methods.

- zero-input-panel-minibuffer.el

  a zero-panel dbus service implemented using Emacs minibuffer.

- zero-input-panel-posframe.el

  a zero-panel dbus service implemented using [[https://github.com/tumashu/posframe][posframe]] package.

* License
zero-el is under Apache License 2.0

+33 −20
Original line number Diff line number Diff line
@@ -114,10 +114,10 @@ cd ~/lisp/elisp/zero/
  press F1 and start typing.

- make a git commit in master branch.
- copy zero-input.el and optional feature files over to pkg branch.
- to make a release for zero-input package,

  copy zero-input.el to pkg branch.
  cp zero-input.el ../zero-pkg/
  cp zero-input-panel-posframe.el ../zero-pkg/
  cp zero-input-panel-minibuffer.el ../zero-pkg/

  make a git commit in pkg branch.
  tag it if it is a stable release.
@@ -125,6 +125,17 @@ cd ~/lisp/elisp/zero/
- push commits.
  push tags if it is a stable release.

*** how to make a release for zero-input-panel-posframe package
- update version comment in zero-input-panel-posframe.el

  cp zero-input-panel-posframe.el ../zero-posframe/

  make a git commit in posframe branch.
  tag it if it is a stable release.

- push commits.
  push tags if it is a stable release.

** 2019-10-10 documents
- Using of D-Bus
  https://www.gnu.org/software/emacs/manual/html_mono/dbus.html
@@ -196,23 +207,6 @@ may show in the wrong instance.

* current                                                             :entry:
** 
** 2024-05-26 make a release on melpa.
- DONE should zero-input-panel-minibuffer.el be included in zero-input.el?
  it doesn't require any other package.
  could be a built-in feature.

- should zero-input-panel-posframe.el be a separate package?
  one file per package is cooler.

  https://github.com/melpa/melpa?tab=readme-ov-file#example-multiple-packages-in-one-repository

  yeah, should create a new package.
  zero-input-panel-posframe

  create a pull request.

- update blog post, add some screenshot of different panels.

** 2021-08-08 create a panel for wayland display server.
currently zero-panel doesn't position itself correctly in wayland on debian 11
bullseye.
@@ -257,6 +251,25 @@ I don't know it should recommend or suggest.
** 2019-10-23 checkdoc and package-lint can't ignore some non-issues.
I can't run them in git pre-commit hook.
* done                                                                :entry:
** 2024-05-26 make a release on melpa.
- DONE should zero-input-panel-minibuffer.el be included in zero-input.el?
  it doesn't require any other package.
  could be a built-in feature.

- DONE should zero-input-panel-posframe.el be a separate package? yes.
  one file per package is cooler.

  https://github.com/melpa/melpa?tab=readme-ov-file#example-multiple-packages-in-one-repository

  yeah, should create a new package.
  zero-input-panel-posframe

  create a pull request.

  where are metadata added? auto parse from README file and source file?

- MOVED update blog post, add some screenshot of different panels.

** 2024-05-26 fix package lint issues
6 issues found:

+1 −0
Original line number Diff line number Diff line
@@ -13,6 +13,7 @@
;; limitations under the License.

;; URL: https://gitlab.emacsos.com/sylecn/zero-el
;; Version: 1.0.0
;; Package-Requires: ((emacs "24.4") (zero-input "2.9.0") (posframe "1.4.3"))

;;; Commentary: