geekinney/tp
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update documentation: tp-set entire-string form now supports layer names

Browse Source 
Updated both English and Chinese documentation to reflect that
when setting text properties on an entire string, it now supports
not only flat properties (PROPERTY VALUE ...) but also layer names
defined by tp-define-layer or tp-define-layer-group.

Co-authored-by: Kinneyzhang <38454496+Kinneyzhang@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2025-12-20 14:10:42 +00:00
parent 7b4c2a0e63
commit 7d88744f85
2 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -136,8 +136,9 @@ Native Emacs APIs have different functions and parameter orders for strings and
(tp-set START END '(face bold))
;; 2. Specific buffer or string
(tp-set START END '(face bold) OBJECT)
;; 3. Entire string (flat properties)
;; 3. Entire string (flat properties or layer name)
(tp-set STRING 'face 'bold 'help-echo "tip")
(tp-set STRING 'layer-name)
```
- ✅ **Unified Object Support**: The same function works with both strings and buffers, no need to remember different APIs
@ -411,8 +412,9 @@ Set text properties on a string or buffer region. Replaces only the specified pr
(tp-set START END '(PROPERTY VALUE ...) OBJECT)
(tp-set START END LAYER-NAME OBJECT)
;; Entire string (flat properties)
;; Entire string (flat properties or layer name)
(tp-set STRING PROPERTY VALUE ...)
(tp-set STRING LAYER-NAME)
```
LAYER-NAME can be a symbol representing a layer defined by `tp-define-layer` or a group defined by `tp-define-layer-group`.
@ -456,6 +458,13 @@ LAYER-NAME can be a symbol representing a layer defined by `tp-define-layer` or
;; Set properties on entire string
(tp-set "Hello" 'face 'bold 'mouse-face 'highlight)
;; => #("Hello" 0 5 (face bold mouse-face highlight))
;; Use a defined layer name on entire string
(tp-define-layer my-style
:props (face (:foreground $my-color))
:data ((my-color . "blue")))
(tp-set " " 'my-style)
;; => #(" " 0 1 (tp-name my-style face (:foreground "blue") ...))
```
---

19
README_CN.md
View File

@ -135,8 +135,9 @@
(tp-set START END '(face bold))
;; 2. 指定缓冲区或字符串
(tp-set START END '(face bold) OBJECT)
;; 3. 整个字符串（平铺属性）
;; 3. 整个字符串（平铺属性或层名称）
(tp-set STRING 'face 'bold 'help-echo "tip")
(tp-set STRING 'layer-name)
```
- ✅ **统一对象支持**：同一个函数同时支持字符串和缓冲区，无需记忆不同的 API
@ -410,8 +411,9 @@ tp.el 所有函数按类别组织的完整概览：
(tp-set START END '(PROPERTY VALUE ...) OBJECT)
(tp-set START END LAYER-NAME OBJECT)
;; 整个字符串（平铺属性）
;; 整个字符串（平铺属性或层名称）
(tp-set STRING PROPERTY VALUE ...)
(tp-set STRING LAYER-NAME)
```
LAYER-NAME 可以是通过 `tp-define-layer` 定义的层名称或通过 `tp-define-layer-group` 定义的层组名称。
@ -448,13 +450,12 @@ LAYER-NAME 可以是通过 `tp-define-layer` 定义的层名称或通过 `tp-def
(tp-set "Hello" 'face 'bold 'mouse-face 'highlight)
;; => #("Hello" 0 5 (face bold mouse-face highlight))
;; 使用已定义的层名称
(tp-define-layer warning-style
(face (:foreground "orange" :weight bold)))
(with-temp-buffer
(insert "Hello World")
(tp-set 1 10 'warning-style))
;; => (1 . 10)
;; 在整个字符串上使用已定义的层名称
(tp-define-layer my-style
:props (face (:foreground $my-color))
:data ((my-color . "blue")))
(tp-set " " 'my-style)
;; => #(" " 0 1 (tp-name my-style face (:foreground "blue") ...))
```
---