changeset 52912:2fdb8b16bceb

(Documentation Tips): Document new behavior for face and variable hyperlinks in Help mode.
author Luc Teirlinck <teirllm@auburn.edu>
date Wed, 22 Oct 2003 18:33:28 +0000
parents 5d2ffd652f23
children 80a49ba70b47
files lispref/tips.texi
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/tips.texi	Wed Oct 22 08:30:13 2003 +0000
+++ b/lispref/tips.texi	Wed Oct 22 18:33:28 2003 +0000
@@ -695,6 +695,16 @@
 does not make a hyperlink to the documentation, irrelevant here, of the
 function @code{list}.
 
+Normally, no hyperlink is made for a variable without variable
+documentation.  You can force a hyperlink for such variables by
+preceding them with one of the words @samp{variable} or
+@samp{option}.
+
+Hyperlinks for faces are only made if the face name is preceded or
+followed by the word @samp{face}.  In that case, only the face
+documentation will be shown, even if the symbol is also defined as a
+variable or as a function.
+
 To make a hyperlink to Info documentation, write the name of the Info
 node in single quotes, preceded by @samp{info node} or @samp{Info
 node}.  The Info file name defaults to @samp{emacs}.  For example,