[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/popper 767d4ffd0e 039/102: Modified README for clarity
From: |
ELPA Syncer |
Subject: |
[elpa] externals/popper 767d4ffd0e 039/102: Modified README for clarity |
Date: |
Fri, 8 Sep 2023 15:58:52 -0400 (EDT) |
branch: externals/popper
commit 767d4ffd0eac9da272a09eeedb640557c85aec00
Author: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Commit: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Modified README for clarity
---
README.org | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/README.org b/README.org
index ecd7a3c507..7261931b77 100644
--- a/README.org
+++ b/README.org
@@ -9,14 +9,14 @@ documentation, compilation or shell output, etc.
There is a [[https://www.youtube.com/watch?v=E-xUNlZi3rI][detailed demo of
Popper here]].
-By default, popper will display your popups in a non-obtrusive way, but it
works
-best in conjunction with some system to handle window creation and placement,
-like =shackle.el=. This package summons windows defined by the user as "popups"
-by simply calling =display-buffer=.
-
You can pre-designate any buffer (by name or major-mode) as a popup, and the
status will be automatically applied when Emacs creates it.
+By default, your popups are displayed in a non-obtrusive way, but Popper
+respects window rules for buffers that you might have in =display-buffer-alist=
+or created using a window management package like =shackle.el=. Popper summons
+windows defined by the user as "popups" by simply calling =display-buffer=.
+
**** Toggle a popup:
#+ATTR_ORG: :width 500
#+ATTR_HTML: :width 500px
@@ -139,14 +139,16 @@ However this means you can't have more than one popup
open at a time. You may al
#+begin_src emacs-lisp
(setq popper-display-control t) ;This is the DEFAULT behavior
#+end_src
-
You can customize =popper-display-function= to show popups any way you'd like.
Any =display-buffer=
[[https://www.gnu.org/software/emacs/manual/html_node/elisp/Buffer-Display-Action-Functions.html][action
function]] can work, or you can write your own. For
-example, setting it to =display-buffer-in-child-frame= will cause popups to be
-displayed in a child frame.
+example, setting it as
+#+BEGIN_SRC emacs-lisp
+ (setq popper-display-function #'display-buffer-in-child-frame)
+#+END_SRC
+will cause popups to be displayed in a child frame.
*** Popup placement controlled using =display-buffer-alist= or =shackle.el=:
-If you already have rules in place for how various buffers should be
displayed, such as by customizing =display-buffer-alist= or with =shackle.el=,
popper will respect them:
+If you already have rules in place for how various buffers should be
displayed, such as by customizing =display-buffer-alist= or with =shackle.el=,
popper will respect them once you set =popper-display-control= to nil:
#+begin_src emacs-lisp
(use-package shackle
- [elpa] externals/popper 851d838821 065/102: Extracted popper-echo into a separate library, (continued)
- [elpa] externals/popper 851d838821 065/102: Extracted popper-echo into a separate library, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 7afd502b3b 068/102: Fixed popper-echo display when the group is a symbol, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 667dcdd063 069/102: Added badge, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 4d58a6dbba 076/102: Handle unbound dispatch keys in popper-echo, ELPA Syncer, 2023/09/08
- [elpa] externals/popper d5ab9b2c41 077/102: Popup without selecting (#17), ELPA Syncer, 2023/09/08
- [elpa] externals/popper a93ff38ab6 098/102: popper: Assign copyright to FSF, ELPA Syncer, 2023/09/08
- [elpa] externals/popper fd39948875 024/102: Removed redundant info from documentation, ELPA Syncer, 2023/09/08
- [elpa] externals/popper b32abcba49 030/102: Fixed popup display of newly created popup buffers, ELPA Syncer, 2023/09/08
- [elpa] externals/popper c465e0de24 007/102: Added technical notes to README, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 7f61e916ce 037/102: Child frame support for popper (ongoing), ELPA Syncer, 2023/09/08
- [elpa] externals/popper 767d4ffd0e 039/102: Modified README for clarity,
ELPA Syncer <=
- [elpa] externals/popper 096078acea 040/102: Add `perspective`-based grouping function (#5), ELPA Syncer, 2023/09/08
- [elpa] externals/popper 0e16eb9b86 050/102: Tweaks to readme, major-mode identification code, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 0127de7161 052/102: Updated Readme for readability + handle project-current when nil, ELPA Syncer, 2023/09/08
- [elpa] externals/popper a29c603acd 055/102: Merge branch 'feature' of github.com:karthink/popper into feature, ELPA Syncer, 2023/09/08
- [elpa] externals/popper b9673ae612 059/102: Fix popper-window-height usage, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 9b1cff1b57 061/102: Popups are updated correctly now, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 032e75bf08 063/102: Added feature to show popups in echo area when cycling., ELPA Syncer, 2023/09/08
- [elpa] externals/popper 8d2b664465 067/102: Popper-echo will use up to 2 minibuffer lines by default, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 9e368e1d20 072/102: Clarify: Does not support popups in new frames, ELPA Syncer, 2023/09/08
- [elpa] externals/popper 6a2ddcb354 073/102: Added tip to match shell buffers, ELPA Syncer, 2023/09/08