GNU bug report logs - #40900
Add face for function params in info

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 40900 in the body.
You can then email your comments to 40900 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: ndame <ndame <at> protonmail.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: Add face for function params in info
Date: Mon, 27 Apr 2020 12:46:02 +0000

The Elisp info manual could be easier to read if parameters which are capitalized
could have a face too:

   If the minibuffer prompt string PROMPT does not end in ‘:’ ...


Though I don't know if it's possible to add language specific faces to info,
because a capitalized word could mean something else in an other language.

Maybe a face like Info-elisp-param-face which is added only if the current
info is about elisp?

Or simply generalizing it?  Info-capitalized-word-face?

Message #10 received at 40900 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: ndame <ndame <at> protonmail.com>
Cc: 40900 <at> debbugs.gnu.org
Subject: Re: bug#40900: Add face for function params in info
Date: Mon, 27 Apr 2020 18:06:19 +0300

> Date: Mon, 27 Apr 2020 12:46:02 +0000
> From: ndame via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> The Elisp info manual could be easier to read if parameters which are capitalized
> could have a face too:
> 
>    If the minibuffer prompt string PROMPT does not end in ‘:’ ...
> 
> 
> Though I don't know if it's possible to add language specific faces to info,
> because a capitalized word could mean something else in an other language.
> 
> Maybe a face like Info-elisp-param-face which is added only if the current
> info is about elisp?

I think the challenge is to reliably identify the strings that are
function parameters.  Info files lack the markup that identifies
various symbols in the Texinfo sources, and the code which finds
function arguments must not err too much, or users will complain.

Message #13 received at 40900 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 40900 <at> debbugs.gnu.org, ndame <ndame <at> protonmail.com>
Subject: Re: bug#40900: Add face for function params in info
Date: Wed, 9 Sep 2020 06:22:25 -0700

Eli Zaretskii <eliz <at> gnu.org> writes:

>> Date: Mon, 27 Apr 2020 12:46:02 +0000
>> From: ndame via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
>>
>> The Elisp info manual could be easier to read if parameters which are capitalized
>> could have a face too:
>>
>>    If the minibuffer prompt string PROMPT does not end in ‘:’ ...
>>
>>
>> Though I don't know if it's possible to add language specific faces to info,
>> because a capitalized word could mean something else in an other language.
>>
>> Maybe a face like Info-elisp-param-face which is added only if the current
>> info is about elisp?
>
> I think the challenge is to reliably identify the strings that are
> function parameters.  Info files lack the markup that identifies
> various symbols in the Texinfo sources, and the code which finds
> function arguments must not err too much, or users will complain.

Isn't this therefore a limitation in Texinfo?  We could of course hack
around it, but it sounds like it would risk being error-prone and hard
to maintain.

Message #16 received at 40900 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 40900 <at> debbugs.gnu.org, ndame <at> protonmail.com
Subject: Re: bug#40900: Add face for function params in info
Date: Wed, 09 Sep 2020 18:03:11 +0300

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Wed, 9 Sep 2020 06:22:25 -0700
> Cc: ndame <ndame <at> protonmail.com>, 40900 <at> debbugs.gnu.org
> 
> > I think the challenge is to reliably identify the strings that are
> > function parameters.  Info files lack the markup that identifies
> > various symbols in the Texinfo sources, and the code which finds
> > function arguments must not err too much, or users will complain.
> 
> Isn't this therefore a limitation in Texinfo?  We could of course hack
> around it, but it sounds like it would risk being error-prone and hard
> to maintain.

It is a limitation of the Info format produced from Texinfo sources.
For example, HTML format produced from Texinfo still has markup, which
could be used for such features.

Message #19 received at 40900 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 40900 <at> debbugs.gnu.org, ndame <at> protonmail.com
Subject: Re: bug#40900: Add face for function params in info
Date: Wed, 9 Sep 2020 08:18:41 -0700

tags 40900 + notabug
close 40900
thanks

Eli Zaretskii <eliz <at> gnu.org> writes:

> It is a limitation of the Info format produced from Texinfo sources.
> For example, HTML format produced from Texinfo still has markup, which
> could be used for such features.

So this limitation should be reported to the Texinfo maintainers.  Once
the Info format has support for this, we could work on supporting it in
Emacs.  I'm therefore closing this bug report.

If this conclusion is incorrect, please reply to this email (use "Reply
to all" in your email client) and we can reopen the bug report.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.