README-elpa (1752B)
1 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2 POPON - "POP" FLOATING TEXT "ON" A WINDOW 3 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4 5 6 Popon allows you to pop text on a window, what we call a popon. Popons 7 are window-local and sticky, they don't move while scrolling, and they 8 even don't go away when switching buffer, but you can bind a popon to a 9 specific buffer to only show on that buffer. 10 11 If some popons are annoying you and you can't kill them, do `M-x 12 popon-kill-all' to kill all popons. 13 14 15 1 Installation 16 ══════════════ 17 18 1.1 Package 19 ─────────── 20 21 Install from NonGNU ELPA. 22 23 24 1.2 Quelpa 25 ────────── 26 27 ┌──── 28 │ (quelpa '(popon :fetcher git 29 │ :url "https://codeberg.org/akib/emacs-popon.git")) 30 └──── 31 32 33 1.3 Straight.el 34 ─────────────── 35 36 ┌──── 37 │ (straight-use-package 38 │ '(popon :type git :repo "https://codeberg.org/akib/emacs-popon.git")) 39 └──── 40 41 42 1.4 Manual 43 ────────── 44 45 Download `popon.el' and put it in your `load-path'. 46 47 48 2 Usage 49 ═══════ 50 51 The main entry point is `popon-create', which creates a popon and 52 returns that. Use `popon-kill' to kill it. Popons are immutable, you 53 can't modify them. Most of time you'll want to place the popon at 54 certain point of buffer; call `popon-x-y-at-pos' with the point and 55 use the return value as the coordinates. Be sure see the docstring of 56 each function, they describe the best.