From: Robert Pluim <rpluim@gmail.com>
Date: Tue, 24 Sep 2024 15:03:49 +0000 (+0200)
Subject: Document 'buttonize-region' in manual
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=6124d26fe58d9ed3e16e8cd2ea805d6b443ff69d;p=emacs.git

Document 'buttonize-region' in manual

It was added in emacs-29, but never added to the lisp reference
manual.

* doc/lispref/display.texi (Making Buttons): Document
'buttonize-region'.

(cherry picked from commit 4729065ee78c260538974c2d8010246dce0ebf0c)
---

diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 2844219cf61..1362806fee7 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -7983,6 +7983,15 @@ will be called when the user clicks on the button.  The optional
 is called.  If @code{nil}, the button is used as the parameter instead.
 @end defun
 
+@defun buttonize-region start end callback &optional data help-echo
+Sometimes it's more convenient to convert existing text in a buffer to a
+button instead of inserting new text.  This function makes the region
+between @var{start} and @var{end} into a button.  Arguments
+@var{callback} and @var{data} have the same meanings as for
+@code{buttonize}.  Optional argument @var{help-echo} is used as the
+@code{help-echo} property of the button.
+@end defun
+
 @node Manipulating Buttons
 @subsection Manipulating Buttons
 @cindex manipulating buttons