(Documentation Tips): Document new behavior for face and variable

hyperlinks in Help mode.
This commit is contained in:
Luc Teirlinck 2003-10-22 18:33:28 +00:00
parent 855c2ccde4
commit e72850d51b

View file

@ -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,