diff options
author | Eli Zaretskii <[email protected]> | 2008-10-15 11:27:32 +0000 |
---|---|---|
committer | Eli Zaretskii <[email protected]> | 2008-10-15 11:27:32 +0000 |
commit | 9cf52b11bbeec82a0ede9fb89fce1033b275e467 (patch) | |
tree | 5a8eb0559044f8ed4caa88197dc75f758ab9ce4f /doc/lispref/modes.texi | |
parent | 61ab9392dedf37bd379f3bdd586e4f12a2965218 (diff) |
(Major Mode Conventions, Mode Line Variables): `mode-name' need not be a
string. xref to "Mode Line Data" for details, and to "Emulating Mode Line"
for computing a string value.
Diffstat (limited to 'doc/lispref/modes.texi')
-rw-r--r-- | doc/lispref/modes.texi | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 3004ca3a93..3227aa3bdc 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -317,8 +317,9 @@ which documentation to print. @item The major mode command should set the variable @code{mode-name} to the -``pretty'' name of the mode, as a string. This string appears in the -mode line. +``pretty'' name of the mode, usually a string (but see @ref{Mode Line +Data}, for other possible forms). The name of the mode appears +in the mode line. @item @cindex functions in modes @@ -1865,8 +1866,12 @@ effect. @defvar mode-name This buffer-local variable holds the ``pretty'' name of the current -buffer's major mode. Each major mode should set this variable so that the -mode name will appear in the mode line. +buffer's major mode. Each major mode should set this variable so that +the mode name will appear in the mode line. The value does not have +to be a string, but can use any of the data types valid in a mode-line +construct (@pxref{Mode Line Data}). To compute the string that will +identify the mode name in the mode line, use @code{format-mode-line} +(@pxref{Emulating Mode Line}). @end defvar @defvar mode-line-process |