From: Luc Teirlinck <teirllm@auburn.edu>
Date: Wed, 22 Oct 2003 18:33:28 +0000 (+0000)
Subject: (Documentation Tips): Document new behavior for face and variable
X-Git-Tag: ttn-vms-21-2-B4~8484
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e72850d51b2751f120c568e8f198d6b56fd04b0c;p=emacs.git

(Documentation Tips): Document new behavior for face and variable
hyperlinks in Help mode.
---

diff --git a/lispref/tips.texi b/lispref/tips.texi
index 0c16ebac2bc..1b40685ba5d 100644
--- a/lispref/tips.texi
+++ b/lispref/tips.texi
@@ -695,6 +695,16 @@ that satisfy the criterion.
 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,