[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/posframe 67a782f 09/10: Update README
From: |
Feng Shu |
Subject: |
[elpa] externals/posframe 67a782f 09/10: Update README |
Date: |
Wed, 13 Mar 2019 08:50:26 -0400 (EDT) |
branch: externals/posframe
commit 67a782f822b62dcf748dd1d7f92adfe2008ec4f3
Author: Feng Shu <address@hidden>
Commit: Feng Shu <address@hidden>
Update README
---
README.md | 58 ++++++++++++++++++++++++++++++----------------------------
posframe.el | 13 +++++++------
2 files changed, 37 insertions(+), 34 deletions(-)
diff --git a/README.md b/README.md
index 8648b3b..8381513 100644
--- a/README.md
+++ b/README.md
@@ -3,23 +3,23 @@ Note: this file is auto converted from posframe.el by
[el2org](https://github.co
# 目录
-1. [Posframe README](#org83cbaa0)
- 1. [What is posframe](#org3ce725d)
- 2. [Installation](#org545827a)
- 3. [Usage](#orgdac766b)
- 1. [Create a posframe](#orgea6aecd)
- 2. [Hide a posframe](#orga5310b9)
- 3. [Hide all posframes](#orgbf09855)
- 4. [Delete a posframe](#org68db811)
- 5. [Delete all posframes](#org12f2467)
+1. [Posframe README](#org3c803d7)
+ 1. [What is posframe](#orge01c383)
+ 2. [Installation](#org0e86f77)
+ 3. [Usage](#orged3f863)
+ 1. [Create a posframe](#org675e151)
+ 2. [Hide a posframe](#orgb91d9ff)
+ 3. [Hide all posframes](#org9ad2afb)
+ 4. [Delete a posframe](#org62bd3a2)
+ 5. [Delete all posframes](#org10ff130)
-<a id="org83cbaa0"></a>
+<a id="org3c803d7"></a>
# Posframe README
-<a id="org3ce725d"></a>
+<a id="orge01c383"></a>
## What is posframe
@@ -36,72 +36,73 @@ NOTE: For MacOS users, posframe need Emacs (version >=
26.0.91)
![img](./snapshots/posframe-1.png)
-<a id="org545827a"></a>
+<a id="org0e86f77"></a>
## Installation
(require 'posframe)
-<a id="orgdac766b"></a>
+<a id="orged3f863"></a>
## Usage
-<a id="orgea6aecd"></a>
+<a id="org675e151"></a>
### Create a posframe
1. Simple way
- NOTE: buffers prefixed with space will be not showed in buffer-list.
- (posframe-show " *my-posframe-buffer*"
- :string "This is a test"
- :position (point))
+ (when (posframe-workable-p)
+ (posframe-show " *my-posframe-buffer*"
+ :string "This is a test"
+ :position (point)))
2. Advanced way
(defvar my-posframe-buffer " *my-posframe-buffer*")
-
+
(with-current-buffer (get-buffer-create my-posframe-buffer)
(erase-buffer)
(insert "Hello world"))
-
- (posframe-show my-posframe-buffer
- :position (point))
+
+ (when (posframe-workable-p)
+ (posframe-show my-posframe-buffer
+ :position (point)))
3. Arguments
C-h f posframe-show
-<a id="orga5310b9"></a>
+<a id="orgb91d9ff"></a>
### Hide a posframe
(posframe-hide " *my-posframe-buffer*")
-<a id="orgbf09855"></a>
+<a id="org9ad2afb"></a>
### Hide all posframes
M-x posframe-hide-all
-<a id="org68db811"></a>
+<a id="org62bd3a2"></a>
### Delete a posframe
1. Delete posframe and its buffer
-
+
(posframe-delete " *my-posframe-buffer*")
2. Only delete posframe's frame
-
+
(posframe-delete-frame " *my-posframe-buffer*")
-<a id="org12f2467"></a>
+<a id="org10ff130"></a>
### Delete all posframes
@@ -110,3 +111,4 @@ NOTE: For MacOS users, posframe need Emacs (version >=
26.0.91)
Note: this command will delete all posframe buffers,
suggest not run this command if you are sharing a buffer
between posframe and other packages.
+
diff --git a/posframe.el b/posframe.el
index 06cf7df..6e87498 100644
--- a/posframe.el
+++ b/posframe.el
@@ -52,10 +52,10 @@
;; **** Simple way
;; #+BEGIN_EXAMPLE
-;; ;; NOTE: buffers prefixed with space will be not showed in buffer-list.
-;; (posframe-show " *my-posframe-buffer*"
-;; :string "This is a test"
-;; :position (point))
+;; (when (posframe-workable-p)
+;; (posframe-show " *my-posframe-buffer*"
+;; :string "This is a test"
+;; :position (point)))
;; #+END_EXAMPLE
;; **** Advanced way
@@ -66,8 +66,9 @@
;; (erase-buffer)
;; (insert "Hello world"))
-;; (posframe-show my-posframe-buffer
-;; :position (point))
+;; (when (posframe-workable-p)
+;; (posframe-show my-posframe-buffer
+;; :position (point)))
;; #+END_EXAMPLE
;; **** Arguments
- [elpa] externals/posframe updated (d141d56 -> 96dbc49), Feng Shu, 2019/03/13
- [elpa] externals/posframe 4a9634e 02/10: * posframe.el (posframe--create-posframe): Set truncate-lines nil, Feng Shu, 2019/03/13
- [elpa] externals/posframe edfbff5 03/10: Add internal-border-width argument, Feng Shu, 2019/03/13
- [elpa] externals/posframe 2cac834 01/10: * posframe.el (posframe--create-posframe): remove left/right-margin, Feng Shu, 2019/03/13
- [elpa] externals/posframe 6c4d7ad 05/10: * posframe.el (posframe-workable-p): New function., Feng Shu, 2019/03/13
- [elpa] externals/posframe 3eaf066 04/10: * posframe.el (posframe-show): Make sure not hide buffer's content for scroll down., Feng Shu, 2019/03/13
- [elpa] externals/posframe 96dbc49 10/10: bump version 0.4.3, Feng Shu, 2019/03/13
- [elpa] externals/posframe cdce1e9 07/10: update posframe-1.png, Feng Shu, 2019/03/13
- [elpa] externals/posframe 9d24df0 08/10: update posframe-1.png again, Feng Shu, 2019/03/13
- [elpa] externals/posframe 0881088 06/10: * posframe.el (posframe-show): Add &allow-other-keys, Feng Shu, 2019/03/13
- [elpa] externals/posframe 67a782f 09/10: Update README,
Feng Shu <=