summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2024-03-08 15:06:37 +0200
committerEli Zaretskii <eliz@gnu.org>2024-03-08 15:06:37 +0200
commitb9f7a2274f6a8352085d01c15bf9086ffe25f437 (patch)
tree5e18d151bcc37e26fc89032bd8e20dd21b24e410 /doc
parent5ffcca121bb79b97c6a0f941c71a61505032d8f8 (diff)
downloademacs-b9f7a2274f6a8352085d01c15bf9086ffe25f437.tar.gz
; Improve documentation of 'minibuffer-allow-text-properties'
* doc/lispref/minibuf.texi (Text from Minibuffer): Document the default value of 'minibuffer-allow-text-properties'.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/minibuf.texi14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index 8c610018745..65a9dca52f4 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -187,7 +187,8 @@ History}.
If the variable @code{minibuffer-allow-text-properties} is
non-@code{nil}, then the string that is returned includes whatever text
properties were present in the minibuffer. Otherwise all the text
-properties are stripped when the value is returned.
+properties are stripped when the value is returned. (By default this
+variable is @code{nil}.)
@vindex minibuffer-prompt-properties
The text properties in @code{minibuffer-prompt-properties} are applied
@@ -350,14 +351,15 @@ See @code{read-regexp} above for details of how these values are used.
@end defopt
@defvar minibuffer-allow-text-properties
-If this variable is @code{nil}, then @code{read-from-minibuffer}
-and @code{read-string} strip all text properties from the minibuffer
-input before returning it. However,
+If this variable is @code{nil}, the default, then
+@code{read-from-minibuffer} and @code{read-string} strip all text
+properties from the minibuffer input before returning it. However,
@code{read-no-blanks-input} (see below), as well as
@code{read-minibuffer} and related functions (@pxref{Object from
Minibuffer,, Reading Lisp Objects With the Minibuffer}), and all
-functions that do minibuffer input with completion, remove the @code{face}
-property unconditionally, regardless of the value of this variable.
+functions that do minibuffer input with completion, remove the
+@code{face} property unconditionally, regardless of the value of this
+variable.
If this variable is non-@code{nil}, most text properties on strings
from the completion table are preserved---but only on the part of the