alphapapa / Yequake
Labels
Projects that are alternatives of or similar to Yequake
#+TITLE: yequake #+PROPERTY: LOGGING nil
https://github.com/alphapapa/org-make-toc package, which automatically updates the table of contents.
Note: This readme works with the org-make-toc[[https://melpa.org/#/yequake][file:https://melpa.org/packages/yequake-badge.svg]]
[[https://stable.melpa.org/#/package-name][file:https://stable.melpa.org/packages/yequake-badge.svg]]
This package provides configurable, drop-down Emacs frames, similar to drop-down terminal windows programs, like Yakuake. Each frame can be customized to display certain buffers in a certain way, at the desired height, width, and opacity. The idea is to call the =yequake-toggle= command from outside Emacs, using =emacsclient=, by binding a shell command to a global keyboard shortcut in the desktop environment. Then, with a single keypress, the desired Emacs frame can be toggled on and off, showing the desired buffers.
There are many options to configure yequake-frames, but the customization UI makes it easy. Try @@html:@@M-x customize-option RET yequake-frames [email protected]@html:@@
- Screenshots :PROPERTIES: :TOC: ignore :END:
Note that the animation of the Emacs frame in this example is provided by the window manager. Yequake simply displays the frame.
[[images/animation.gif]]
That animation was produced with this yequake-frames configuration:
#+BEGIN_SRC elisp (setq yequake-frames '(("Yequake & scratch" . ((width . 0.75) (height . 0.5) (alpha . 0.95) (buffer-fns . ("~/src/emacs/yequake/yequake.el" split-window-horizontally "scratch")) (frame-parameters . ((undecorated . t))))))) #+END_SRC
To activate it, call this command from a shell, e.g. by binding it to a global keyboard shortcut:
#+BEGIN_SRC sh emacsclient -n -e '(yequake-toggle "Yequake & scratch")' #+END_SRC
-
Contents :noexport: :PROPERTIES: :TOC: this :END:
- [[#installation][Installation]]
- [[#usage][Usage]]
- [[#changelog][Changelog]]
- [[#credits][Credits]]
-
Installation :PROPERTIES: :TOC: 0 :END:
** Quelpa
[[https://framagit.org/steckerhalter/quelpa-use-package][quelpa-use-package]] makes installation easy:
#+BEGIN_SRC elisp (use-package yequake :quelpa (yequake :fetcher github :repo "alphapapa/yequake")) #+END_SRC
** MELPA
If you installed from MELPA, you're done!
** Manual
Put =yequake.el= in your =load-path=, and this in your init file:
#+BEGIN_SRC elisp (require 'yequake) #+END_SRC
- Usage :PROPERTIES: :TOC: 0 :END:
- Start an Emacs daemon (e.g. with =emacs --daemon=, or @@html:@@M-x server-start [email protected]@html:@@).
- Configure =yequake-frames=, e.g. with @@html:@@M-x customize-option RET yequake-frames [email protected]@html:@@.
- Call
yequake-toggle:- From inside Emacs, it can be called as an interactive command with @@html:@@M-x yequake-toggle [email protected]@html:@@, and will prompt for a Yequake frame.
- From outside Emacs, call =emacsclient= and eval the command with the name of a Yequake frame, like:
#+BEGIN_SRC sh emacsclient -n -e '(yequake-toggle "FRAME-NAME")' #+END_SRC
You'll probably want to bind that to a global keyboard shortcut in your desktop environment.
- Call
yequake-toggleagain to hide the frame.
** Tips
- You can customize settings in the =yequake= group.
- The
yequake-retogglecommand toggles the most recently toggled frame.
** Org Capture
The yequake-org-capture function is suitable for use in a Yequake frame used for Org Capture. It calls org-capture and sets org-capture-after-finalize-hook to close the Yequake frame after the capture is finalized or canceled. (Note that if another Yequake frame is toggled before the capture is finalized, when the capture is finalized, the wrong Yequake frame will be toggled.) For example, with this configuration:
#+BEGIN_SRC elisp (use-package yequake :quelpa (yequake :fetcher github :repo "alphapapa/yequake")
:custom
(yequake-frames
'(("org-capture"
(buffer-fns . (yequake-org-capture))
(width . 0.75)
(height . 0.5)
(alpha . 0.95)
(frame-parameters . ((undecorated . t)
(skip-taskbar . t)
(sticky . t)))))))
#+END_SRC
You could then run:
#+BEGIN_SRC sh emacsclient -n -e '(yequake-toggle "org-capture")' #+END_SRC
And after the capture is finalized or canceled, the frame will be closed, like this:
[[images/org-capture.gif]]
- Changelog :PROPERTIES: :TOC: 0 :END:
** 0.1
First tagged release.
- Credits
- This package was inspired by Benjamin Slade's [[https://gitlab.com/emacsomancer/equake][equake]] package, and by good ol' Yakuake.
- The animations were created with [[https://github.com/alphapapa/bashcaster][Bashcaster]] and GIMP.
- Development :PROPERTIES: :TOC: ignore :END:
Bug reports, feature requests, suggestions — /oh my/!
- License :PROPERTIES: :TOC: ignore :END:
GPLv3