[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Update of Mode Line Format in the Lisp Reference Manual.

From: Eli Zaretskii
Subject: Re: Update of Mode Line Format in the Lisp Reference Manual.
Date: Sat, 27 Sep 2003 13:42:59 +0200

> From: Lute Kamstra <address@hidden>
> Date: Thu, 25 Sep 2003 17:45:18 +0200
> I've updated the Mode Line Format node of the Lisp Reference Manual.
> I documented a couple of new features like the (:propertize elt
> props...) construct and the mode-line-position and mode-line-modes
> variables.  It would be nice if people involved in their
> implementation would look at it before I commit the update.


A few minor comments:

> + @item (:propertize @var{elt} @address@hidden)
> + A list whose first element is the symbol @code{:propertize} says to
> + process the mode line construct @var{elt} recursively and add the text
> + properties specified by @var{props} to the result.  The argument
> + @var{props} should consist of zero or more pairs @var{text-property}
> + @var{value}.  (This feature is new as of Emacs 21.4.)
> + @c FIXME: This might be Emacs 21.5.

I think it's a good idea to add an index entry here, for users who
might be looking for information on putting text properties on
mode-line text.

In general, I'd suggest to re-read your changes and try to add index
entries for every piece of information that a user might need to find
quickly.  Think of programmers like you and me who need to write some
Lisp code related to the features you describe, but who do not know by
heart the names of functions/variables you are describing.

> ! This variable holds the value of the mode-line construct that displays
>   whether the current buffer is modified.
>   The default value of @code{mode-line-modified} is @code{("%1*%1+")}.
> --- 1322,1334 ----
>   @code{mode-line-format} were changed to use them.
>   @defvar mode-line-mule-info
> ! This variable holds the value of the mode line construct that displays

I see that you've consistently replaced "mode-line" with "mode line"
in this and similar contexts.  I'm not sure which variant is more
correct English; please note that the phrase "mode-line construct" can
be rephrased as "construct of the mode line".  I tend to write the
dash in the former, but not in the latter.  However, since English is
not my first language, I'll leave the decision to others.

> ! @defvar mode-line-position
> ! This variable indicates the position in the buffer.  The default value
> ! (with text properties omitted) is:

The Texinfo directive @defvar (as well as its other @def* brethren)
defines a @vindex entry for its argument, which is good.  However, if
a user looks for this information without knowing the name of the
variable, she will still be lost.  Thus, I think that, ideally, every
variable here should have a @cindex entry as well.  For example, the
variable mode-line-position might have these entries:

  @cindex buffer position indication, in mode line
  @cindex mode line, buffer position indication

Thanks again for all your work.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]